Struct PropertyDecl 

#[non_exhaustive]
pub struct PropertyDecl {
    pub name: SmolStr,
    pub ty: PropertyType,
    pub required: bool,
}

A declared property on a label or relationship type.

Marked #[non_exhaustive] (cy-2i9.1) so new fields (e.g. documentation, default) can land without forcing a SemVer-major release. External crates construct via PropertyDecl::new.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: SmolStr

Property name as it appears in n.prop expressions.

ty: PropertyType

Declared type (spec §8.2). Consumers that don’t care about typing can surface PropertyType::Any.

required: bool

true when the schema requires every instance to carry this property (nullable otherwise).

Implementations

impl PropertyDecl

pub fn new(name: impl Into<SmolStr>, ty: PropertyType, required: bool) -> Self

Construct a PropertyDecl.

This is the SemVer-stable constructor; external crates should prefer it over struct literals so the struct can grow fields without forcing a SemVer-major release.

Trait Implementations

impl Clone for PropertyDecl

fn clone(&self) -> PropertyDecl

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PropertyDecl

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PropertyDecl

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PropertyDecl

fn eq(&self, other: &PropertyDecl) -> 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 Serialize for PropertyDecl

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for PropertyDecl

impl StructuralPartialEq for PropertyDecl