Struct StatusMapping 

pub struct StatusMapping { /* private fields */ }

One source’s status_mapping: for each status category it mentions, the names it gives each item kind, or null.

Held in the contract’s category order with each category at most once, so iterating it reports in that order and a category named twice is a state it cannot hold.

Implementations

impl StatusMapping

pub fn is_empty(&self) -> bool

Whether the mapping mentions no category at all.

pub fn mentions(&self, category: StatusCategory) -> bool

Whether the mapping mentions category, as a name or as null.

pub fn entry(&self, category: StatusCategory) -> Option<Option<&StatusNames>>

What the mapping says of category: None where it does not mention it, Some(None) where it sets it to null, and the names otherwise.

pub fn name_for( &self, category: StatusCategory, kind: ItemKind, ) -> Result<&StatusName, UnmappedStatus>

The name category is written as for kind, or why the mapping gives none.

Errors

The UnmappedStatus saying which of the three ways the mapping gives no name.

pub fn names( &self, kind: ItemKind, ) -> impl Iterator<Item = (StatusCategory, &StatusName)>

Every name the mapping gives kind, with its category, in category order.

pub fn category_of(&self, kind: ItemKind, name: &str) -> Option<StatusCategory>

The category a kind name reads as, when the mapping names it for that kind.

pub fn distinct<'a>( source: &SourceName, kind: ItemKind, names: impl IntoIterator<Item = (StatusCategory, &'a str)>, ) -> Result<(), SourceError>

Refuse two categories sent to one name of one kind, ignoring case: that name could read back as only one of them.

Takes the names to compare rather than reading this mapping’s own, so a source whose unmentioned categories keep shipped defaults compares what it really resolves to.

Errors

SourceError::Config naming the source, the kind, both categories and the name.

Trait Implementations

impl Clone for StatusMapping

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StatusMapping

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

Formats the value using the given formatter.

impl Default for StatusMapping

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for StatusMapping

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Eq for StatusMapping

impl JsonSchema for StatusMapping

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

impl PartialEq for StatusMapping

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for StatusMapping

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StatusMapping