Skip to main content

TraitMap

Struct TraitMap 

Source
pub struct TraitMap { /* private fields */ }
Expand description

A map of traits keyed by their Shape ID.

This provides efficient lookup of traits during serialization and deserialization.

§Cross-lifetime lookup

Internal storage is keyed by ShapeId<'static> because traits come from codegen-emitted schemas (themselves 'static). The public get and contains accessors accept &ShapeId<'_> of any lifetime — runtime- built shape IDs (e.g. parsed from a wire-format __type field) are looked up against the 'static-keyed table via ShapeId’s Borrow<str> impl, which keys on the fully qualified name.

Implementations§

Source§

impl TraitMap

Source

pub const EMPTY: Self

An empty trait map for use in const contexts (e.g. prelude schemas).

Source

pub fn new() -> Self

Creates a new empty TraitMap.

Source

pub fn insert(&mut self, trait_obj: Box<dyn Trait>)

Inserts a trait into the map.

Source

pub fn get(&self, id: &ShapeId<'_>) -> Option<&dyn Trait>

Gets a trait by its Shape ID.

Accepts a ShapeId of any lifetime — lookup is by fully qualified name. A ShapeId<'static> constructed via the shape_id! macro and a runtime-built ShapeId<'_> with the same FQN resolve to the same entry.

Source

pub fn get_fqn(&self, fqn: &str) -> Option<&dyn Trait>

Looks up a trait by its fully qualified name (e.g. "smithy.api#sensitive").

Equivalent to Self::get when the caller already has the FQN as a string slice — for example, after extracting the __type field from a JSON document.

§Example
use aws_smithy_schema::traits::JsonNameTrait;
use aws_smithy_schema::{shape_id, ShapeId, TraitMap};

let mut traits = TraitMap::new();
traits.insert(Box::new(JsonNameTrait::new("custom_name")));

// Cross-lifetime: a static-lifetime ShapeId from `shape_id!` and a
// runtime-built ShapeId<'_> with the same FQN both resolve via
// `Borrow<str>`. The companion `_fqn` accessor takes `&str` directly.
assert!(traits.get(&shape_id!("smithy.api", "jsonName")).is_some());
assert!(traits.get_fqn("smithy.api#jsonName").is_some());
Source

pub fn contains(&self, id: &ShapeId<'_>) -> bool

Returns true if the map contains a trait with the given Shape ID.

Accepts a ShapeId of any lifetime; see Self::get.

Source

pub fn contains_fqn(&self, fqn: &str) -> bool

Returns true if the map contains a trait with the given fully qualified name. See Self::get_fqn.

Source

pub fn len(&self) -> usize

Returns the number of traits in the map.

Source

pub fn is_empty(&self) -> bool

Returns true if the map is empty.

Trait Implementations§

Source§

impl Debug for TraitMap

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for TraitMap

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more