Struct IndexFragment 

pub struct IndexFragment { /* private fields */ }

One secondary-index proposal definition.

Implementations

impl IndexFragment

pub fn try_new( source_key: IndexSourceKey, name: SchemaName, key: Vec<IndexKeyFragment>, unique: bool, predicate: Option<SourceCheckExpr>, ) -> Result<IndexFragment, SchemaContractError>

Construct one bounded index definition.

Errors

Returns a typed reference-list error when no key component is present.

pub const fn source_key(&self) -> &IndexSourceKey

Borrow the immutable source key.

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

Borrow the editable index name.

pub fn key(&self) -> &[IndexKeyFragment]

Borrow ordered index key components.

pub const fn unique(&self) -> bool

Return whether the index enforces uniqueness.

pub const fn predicate(&self) -> Option<&SourceCheckExpr>

Borrow the optional source predicate.

Trait Implementations

impl CandidType for IndexFragment

fn _ty() -> Type

fn _ty_doc() -> TypeDoc

fn id() -> TypeId

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

where __S: Serializer,

fn ty() -> Type

impl Clone for IndexFragment

fn clone(&self) -> IndexFragment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IndexFragment

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IndexFragment

fn deserialize<__D>( __deserializer: __D, ) -> Result<IndexFragment, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for IndexFragment

impl PartialEq for IndexFragment

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for IndexFragment

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for IndexFragment