Struct reproto_core::RpField

pub struct RpField {
    pub required: bool,
    pub safe_ident: Option<String>,
    pub ident: String,
    pub comment: Vec<String>,
    pub ty: RpType,
    pub field_as: Option<String>,
}

Fields

required: bool

Is the field required.

safe_ident: Option<String>

Mangled identifier, taking target-specific keywords into account.

ident: String

Original identifier used to specify the field.

comment: Vec<String>

Field comments.

ty: RpType

field_as: Option<String>

Alias of field in JSON.

Methods

impl RpField

pub fn new<S: AsRef<str>>(ident: S, ty: RpType) -> Self

pub fn is_optional(&self) -> bool

pub fn is_required(&self) -> bool

pub fn safe_ident(&self) -> &str

Get the keyword-safe identifier.

This will be the identifier escaped to avoid any target-language keywords.

pub fn with_safe_ident<S: AsRef<str>>(self, safe_ident: S) -> RpField

Change the safe identifier.

pub fn ident(&self) -> &str

Get the original identifier of the field.

pub fn name(&self) -> &str

Get the JSON name of the field, if it differs from ident.

TODO: Return Option, currently returns ident. This is a better indication whether 'renaming' should occur.

pub fn display(&self) -> String

Trait Implementations

impl Debug for RpField

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Clone for RpField

fn clone(&self) -> RpField

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq for RpField

fn eq(&self, __arg_0: &RpField) -> bool

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

fn ne(&self, __arg_0: &RpField) -> bool

This method tests for !=.

impl Eq for RpField