Struct abi_stable::type_layout::tagging::Tag

#[repr(C)]pub struct Tag { /* fields omitted */ }

Tag is a dynamically typed data structure used to encode extra properties about a type in its layout constant.

For more information look at the module-level documentation

Implementations

impl Tag

pub const NULL: &'static Tag

pub const fn null() -> Self

Constructs the Null variant.

pub const fn bool_(b: bool) -> Self

Constructs the Bool variant.

pub const fn int(n: i64) -> Self

Constructs the Int variant.

pub const fn uint(n: u64) -> Self

Constructs the UInt variant.

pub const fn str(s: &'static str) -> Self

Constructs the String_ variant.

pub const fn rstr(s: RStr<'static>) -> Self

Constructs the String_ variant.

pub const fn ignored(ignored: &'static Tag) -> Self

Constructs the Ignored variant.

pub const fn arr(s: RSlice<'static, Tag>) -> Self

Constructs the Array variant.

pub const fn set(s: RSlice<'static, Tag>) -> Self

Constructs the Set variant.

pub const fn kv(key: Tag, value: Tag) -> KeyValue<Tag>

Constructs a KeyValue.

pub const fn map(s: RSlice<'static, KeyValue<Tag>>) -> Self

Constructs the Map variant.

impl Tag

pub fn to_checkable(self) -> CheckableTag

Converts the Tag into a CheckableTag, so as to check Tags for compatibility.

Trait Implementations

impl Clone for Tag

pub fn clone(&self) -> Tag

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Tag

impl Debug for Tag

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

Formats the value using the given formatter.

impl Display for Tag

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

Formats the value using the given formatter.

impl Eq for Tag

impl ExtraChecks for Tag

pub fn type_layout(&self) -> &'static TypeLayout

Gets the type layout of Self(the type that implements ExtraChecks)

pub fn check_compatibility(
    &self,
    _layout_containing_self: &'static TypeLayout,
    layout_containing_other: &'static TypeLayout,
    checker: TypeCheckerMut<'_>
) -> RResult<(), ExtraChecksError>

Checks that self is compatible another type which implements ExtraChecks.

pub fn nested_type_layouts(&self) -> RCow<'_, [&'static TypeLayout]>

Returns the TypeLayouts owned or referenced by self.

pub fn combine(
    &self,
    _other: ExtraChecksRef<'_>,
    _checker: TypeCheckerMut<'_>
) -> RResult<ROption<ExtraChecksBox>, ExtraChecksError>

Combines this ExtraChecks trait object with another one.

impl GetStaticEquivalent_ for Tag

type StaticEquivalent = _static_Tag

impl Hash for Tag

pub fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Tag

pub fn cmp(&self, other: &Tag) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Tag> for Tag

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Tag> for Tag

pub fn partial_cmp(&self, other: &Tag) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

pub fn lt(&self, other: &Tag) -> bool

This method tests less than (for self and other) and is used by the < operator.

pub fn le(&self, other: &Tag) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

pub fn gt(&self, other: &Tag) -> bool

This method tests greater than (for self and other) and is used by the > operator.

pub fn ge(&self, other: &Tag) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StableAbi for Tag

type IsNonZeroType = False

Whether this type has a single invalid bit-pattern.

pub const LAYOUT: &'static TypeLayout

The layout of the type provided by implementors.

pub const ABI_CONSTS: AbiConsts

const-equivalents of the associated types.

impl StructuralEq for Tag

impl StructuralPartialEq for Tag