Enum ApiDocFileName 

pub enum ApiDocFileName {
    Lockstep(LockstepApiDocFileName),
    Versioned(VersionedApiDocFileName),
}

Describes the path to an OpenAPI document file, relative to some root where similar documents are found.

Variants

Lockstep(LockstepApiDocFileName)

A lockstep API: single OpenAPI document, no versioning.

Versioned(VersionedApiDocFileName)

A versioned API: multiple versions can coexist.

Implementations

impl ApiDocFileName

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.

pub fn version(&self) -> Option<&Version>

For versioned APIs, returns the version part of the filename.

pub fn hash(&self) -> Option<&str>

For versioned APIs, returns the hash part of the filename.

pub fn is_git_stub(&self) -> bool

Returns true if this is a Git stub.

pub fn versioned_kind(&self) -> Option<VersionedApiDocKind>

For versioned APIs, returns the kind of storage.

pub fn to_json_filename(&self) -> ApiDocFileName

Converts a Git stubname to its JSON equivalent.

For non-Git stubs, returns a clone of self.

pub fn to_git_stub_filename(&self) -> ApiDocFileName

Converts a JSON filename to its Git stub equivalent.

For Git stubs, returns a clone of self. For lockstep files, returns a clone of self (lockstep files are not converted to Git stubs).

pub fn git_stub_basename(&self) -> String

Returns the basename for this file as a Git stub.

• If this is already a Git stub, returns basename() directly.
• If this is a versioned JSON file, returns basename() + ".gitstub".
• For lockstep, returns basename() (lockstep files are not converted to Git stubs).

pub fn json_basename(&self) -> String

Returns the basename for this file as a JSON file.

• If this is a Git stub, returns the basename without the .gitstub suffix.
• Otherwise, returns basename() directly.

pub fn as_versioned(&self) -> Option<&VersionedApiDocFileName>

Returns a reference to the inner VersionedApiDocFileName if this is a versioned API, or None if this is a lockstep API.

pub fn into_versioned(self) -> Option<VersionedApiDocFileName>

Consumes self and returns the inner VersionedApiDocFileName if this is a versioned API, or None if this is a lockstep API.

pub fn as_lockstep(&self) -> Option<&LockstepApiDocFileName>

Returns a reference to the inner LockstepApiDocFileName if this is a lockstep API, or None if this is a versioned API.

pub fn into_lockstep(self) -> Option<LockstepApiDocFileName>

Consumes self and returns the inner LockstepApiDocFileName if this is a lockstep API, or None if this is a versioned API.

Trait Implementations

impl Clone for ApiDocFileName

fn clone(&self) -> ApiDocFileName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiDocFileName

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

Formats the value using the given formatter.

impl Display for ApiDocFileName

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

Formats the value using the given formatter.

impl Eq for ApiDocFileName

impl From<LockstepApiDocFileName> for ApiDocFileName

fn from(l: LockstepApiDocFileName) -> Self

Converts to this type from the input type.

impl From<VersionedApiDocFileName> for ApiDocFileName

fn from(v: VersionedApiDocFileName) -> Self

Converts to this type from the input type.

impl Ord for ApiDocFileName

fn cmp(&self, other: &ApiDocFileName) -> 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 ApiDocFileName

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ApiDocFileName

fn partial_cmp(&self, other: &ApiDocFileName) -> 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 ApiDocFileName