Struct LockstepApiDocFileName 

pub struct LockstepApiDocFileName { /* private fields */ }

A lockstep API document filename.

Lockstep APIs have a single OpenAPI document with no versioning. The filename is simply {ident}.json.

Implementations

impl LockstepApiDocFileName

pub fn new(ident: ApiIdent) -> Self

Creates a new lockstep API document filename.

pub fn ident(&self) -> &ApiIdent

Returns the API identifier.

pub fn path(&self) -> Utf8PathBuf

Returns the path of this file relative to the root of the OpenAPI documents.

pub fn basename(&self) -> String

Returns the base name of this file path.

Trait Implementations

impl Clone for LockstepApiDocFileName

fn clone(&self) -> LockstepApiDocFileName

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LockstepApiDocFileName

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for LockstepApiDocFileName

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for LockstepApiDocFileName

impl From<LockstepApiDocFileName> for ApiDocFileName

fn from(l: LockstepApiDocFileName) -> Self

Converts to this type from the input type.

impl Ord for LockstepApiDocFileName

fn cmp(&self, other: &LockstepApiDocFileName) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for LockstepApiDocFileName

fn eq(&self, other: &LockstepApiDocFileName) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for LockstepApiDocFileName

fn partial_cmp(&self, other: &LockstepApiDocFileName) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for LockstepApiDocFileName