Struct Field 

pub struct Field {
    pub api_name: String,
    pub rust_name: String,
    pub typ: String,
    pub source: Option<Source>,
}

Fields

api_name: String

rust_name: String

typ: String

source: Option<Source>

The source file of the compound type, parsed from the markdown link. None for primitive types and same-file anchor links (#anchor).

Implementations

impl Field

pub fn from_api_name(api_name: String, typ: String) -> Self

pub fn is_optional(&self) -> bool

pub fn is_vec(&self) -> bool

pub fn is_map(&self) -> bool

pub fn is_numeric(&self) -> bool

pub fn is_bool(&self) -> bool

pub fn is_string(&self) -> bool

pub fn is_compound(&self) -> bool

pub fn is_error(&self) -> bool

The field represents some error type

pub fn inner_type(&self) -> Option<&str>

Retrieves the inner type of Option<> or Vec<> Retrieves the value type of BTreeMap<Key, Value> Returns None if the field type is not Option, Vec or BTreeMap.

pub fn inner_type_offset(&self) -> Option<usize>

Like inner_type but returns an offset to the inner type in cthe original type string

pub fn base_type(&self) -> &str

Returns a base type(a type with all container types unwrapped) E.g. Message -> Message Option<Message> -> Message BTreeMap<i64, Option<Vec<Message>>> -> Message

pub fn base_type_offset(&self) -> usize

Like a [base_type] but returns an offset to the base type in the original type string

Trait Implementations

impl Clone for Field

fn clone(&self) -> Field

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Field

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

Formats the value using the given formatter.

impl FromStr for Field

type Err = String

The associated error which can be returned from parsing.

fn from_str(line: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for Field

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

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

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 StructuralPartialEq for Field