Struct ManagedApis 

pub struct ManagedApis { /* private fields */ }

Describes the Rust-defined configuration for all of the APIs managed by this tool.

This is repo-specific state that’s passed into the OpenAPI manager.

Implementations

impl ManagedApis

pub fn new(api_list: Vec<ManagedApiConfig>) -> Result<ManagedApis>

Constructs a new ManagedApis instance from a list of API configurations.

This is the main entry point for creating a new ManagedApis instance.

pub fn with_unknown_apis<I, S>(self, apis: I) -> Self

where I: IntoIterator<Item = S>, S: Into<ApiIdent>,

Adds the given API identifiers (without the ending .json) to the list of unknown APIs.

By default, if an unknown .json file is encountered within the OpenAPI directory, a failure is produced. Use this method to produce a warning for an allowlist of APIs instead.

pub fn with_validation( self, validation: fn(&OpenAPI, ValidationContext<'_>), ) -> Self

Sets a validation function to be used for all APIs.

This function will be called for each API document. The ValidationContext can be used to report errors, as well as extra files for which the contents need to be compared with those on disk.

pub fn validation(&self) -> Option<fn(&OpenAPI, ValidationContext<'_>)>

Returns the validation function for all APIs.

pub fn len(&self) -> usize

Returns the number of APIs managed by this instance.

pub fn is_empty(&self) -> bool

Returns true if there are no APIs managed by this instance.

pub fn unknown_apis(&self) -> &BTreeSet<ApiIdent>

Returns the set of unknown APIs.

Trait Implementations

impl Debug for ManagedApis

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

Formats the value using the given formatter.