Skip to main content

FieldDirective

codama_attributes

Struct FieldDirective

pub struct FieldDirective {
    pub after: bool,
    pub name: CamelCaseString,
    pub type: Resolvable<TypeNode>,
    pub docs: Docs,
    pub default_value: Option<Resolvable<ValueNode>>,
    pub default_value_strategy: Option<DefaultValueStrategy>,
}

Fields§

§after: bool§name: CamelCaseString§type: Resolvable<TypeNode>§docs: Docs§default_value: Option<Resolvable<ValueNode>>§default_value_strategy: Option<DefaultValueStrategy>

Implementations§

impl FieldDirective

pub fn parse(meta: &Meta) -> Result<Self>

pub fn to_struct_field_type_node(&self) -> CodamaResult<StructFieldTypeNode>

Construct a StructFieldTypeNode from this directive. Returns an error if any unresolved directives remain.

Trait Implementations§

impl Debug for FieldDirective

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

Formats the value using the given formatter. Read more

impl From<FieldDirective> for CodamaDirective

fn from(value: FieldDirective) -> Self

Converts to this type from the input type.

impl PartialEq for FieldDirective

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

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> TryFrom<&'a Attribute<'a>> for &'a FieldDirective

type Error = CodamaError

The type returned in the event of a conversion error.

fn try_from(attribute: &'a Attribute<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a CodamaAttribute<'a>> for &'a FieldDirective

type Error = CodamaError

The type returned in the event of a conversion error.

fn try_from(attribute: &'a CodamaAttribute<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for FieldDirective

Auto Trait Implementations§

impl Freeze for FieldDirective

impl RefUnwindSafe for FieldDirective

impl !Send for FieldDirective

impl !Sync for FieldDirective

impl Unpin for FieldDirective

impl UnsafeUnpin for FieldDirective

impl UnwindSafe for FieldDirective

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

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

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<'a, T, U> TryFromFilter<'a, U> for T
where T: 'a, &'a T: TryFrom<U>,

fn filter(u: U) -> Option<&'a T>

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.