Struct EntityFieldDescription 

pub struct EntityFieldDescription { /* private fields */ }

EntityFieldDescription

One field entry in a describe payload.

Implementations

impl EntityFieldDescription

pub fn new( name: String, slot: Option<u16>, kind: String, nullable: bool, primary_key: bool, queryable: bool, origin: String, insert_omission: Option<String>, insert_default: Option<String>, insert_default_bytes: Option<u32>, insert_default_hash: Option<String>, introduced_in_layout: Option<u32>, historical_fill: Option<String>, historical_fill_bytes: Option<u32>, historical_fill_hash: Option<String>, ) -> Self

Construct one field description entry.

pub const fn name(&self) -> &str

Borrow the field name.

pub const fn slot(&self) -> Option<u16>

Return the physical row slot for top-level fields.

pub const fn kind(&self) -> &str

Borrow the rendered field kind label.

pub const fn nullable(&self) -> bool

Return whether this field permits explicit NULL.

pub const fn primary_key(&self) -> bool

Return whether this field is the primary key.

pub const fn queryable(&self) -> bool

Return whether this field is queryable.

pub const fn origin(&self) -> &str

Borrow the accepted/generated field origin label.

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

Borrow the accepted insert-omission policy label for a top-level field.

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

Borrow the bounded canonical accepted insert-default rendering.

pub const fn insert_default_bytes(&self) -> Option<u32>

Return the accepted insert-default payload byte count.

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

Borrow the stable accepted insert-default payload hash.

pub const fn introduced_in_layout(&self) -> Option<u32>

Return the row layout that first physically contained this field.

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

Borrow the accepted frozen historical-absence rendering.

pub const fn historical_fill_bytes(&self) -> Option<u32>

Return the historical-fill payload byte count when one is stored.

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

Borrow the stable historical-fill payload hash.

Trait Implementations

impl CandidType for EntityFieldDescription

fn _ty() -> Type

fn _ty_doc() -> TypeDoc

fn id() -> TypeId

fn idl_serialize<__S>(&self, __serializer: __S) -> Result<(), __S::Error>

where __S: Serializer,

fn ty() -> Type

impl Clone for EntityFieldDescription

fn clone(&self) -> EntityFieldDescription

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EntityFieldDescription

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EntityFieldDescription

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for EntityFieldDescription

impl PartialEq for EntityFieldDescription

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for EntityFieldDescription