Struct VersionedApiDocFileName 

pub struct VersionedApiDocFileName { /* private fields */ }

A versioned API document filename.

Versioned APIs can have multiple versions coexisting. The filename includes the version and a content hash: {ident}/{ident}-{version}-{hash}.json (or .json.gitstub for Git stub storage).

Implementations

impl VersionedApiDocFileName

pub fn new(ident: ApiIdent, version: Version, hash: String) -> Self

Creates a new versioned API document filename (JSON format).

pub fn new_git_stub(ident: ApiIdent, version: Version, hash: String) -> Self

Creates a new versioned API document filename (Git stub format).

pub fn ident(&self) -> &ApiIdent

Returns the API identifier.

pub fn version(&self) -> &Version

Returns the version.

pub fn hash(&self) -> &str

Returns the hash.

pub fn kind(&self) -> VersionedApiDocKind

Returns the storage kind (JSON or Git stub).

pub fn is_git_stub(&self) -> bool

Returns true if this is a Git stub.

pub fn path(&self) -> Utf8PathBuf

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

The path is always joined with a forward slash, including on Windows.

pub fn basename(&self) -> String

Returns the base name of this file path.

pub fn to_json(&self) -> Self

Converts this filename to its JSON equivalent.

If already JSON, returns a clone of self.

pub fn to_git_stub(&self) -> Self

Converts this filename to its Git stub equivalent.

If already a Git stub, returns a clone of self.

pub fn git_stub_basename(&self) -> String

Returns the basename as a Git stubname.

• If already a Git stub, returns basename() directly.
• If JSON, returns basename() + ".gitstub".

pub fn json_basename(&self) -> String

Returns the basename as a JSON filename.

• If already JSON, returns basename() directly.
• If Git stub, returns the basename without .gitstub.

Trait Implementations

impl Clone for VersionedApiDocFileName

fn clone(&self) -> VersionedApiDocFileName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VersionedApiDocFileName

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

Formats the value using the given formatter.

impl Display for VersionedApiDocFileName

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

Formats the value using the given formatter.

impl Eq for VersionedApiDocFileName

impl From<VersionedApiDocFileName> for ApiDocFileName

fn from(v: VersionedApiDocFileName) -> Self

Converts to this type from the input type.

impl Ord for VersionedApiDocFileName

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for VersionedApiDocFileName

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