Skip to main content

FieldSpec

Struct FieldSpec 

Source
pub struct FieldSpec {
    pub field_type: FieldType,
    pub required: bool,
    pub unique: bool,
    pub index: Option<IndexKind>,
    pub fulltext: bool,
    pub cypher: bool,
    pub values: Option<Vec<String>>,
    pub default: Option<DefaultValue>,
    pub addressable: bool,
}

Fields§

§field_type: FieldType§required: bool§unique: bool§index: Option<IndexKind>§fulltext: bool§cypher: bool

NOTE: encryption at rest — parsed/rejected today, AES-256-GCM sealing is not wired up yet.

§values: Option<Vec<String>>§default: Option<DefaultValue>§addressable: bool

Whether this field’s own value is a link target — true for every field, and settable only on a markdown one, where addressable: false means the content still links out but the field holds no virtual path of its own and nothing can link to it.

Implementations§

Source§

impl FieldSpec

Source

pub fn new(field_type: FieldType) -> Self

Source

pub fn has_virtual_path(&self) -> bool

Whether this field carries its own engine-managed virtual path — the index a markdown link resolves against, and the value uniqueness is enforced on. A markdown field declaring addressable: false answers false: it is not a link target, so it needs no path at all.

Trait Implementations§

Source§

impl Clone for FieldSpec

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FieldSpec

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<FieldSpec> for CatalogFieldSpec

Source§

fn from(spec: FieldSpec) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for FieldSpec

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for FieldSpec

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.