Struct KeyField

pub struct KeyField {
    pub path: String,
    pub key: KeyType,
    pub kind: IndexKind,
}

Indexed field definition

Fields

path: String

key: KeyType

kind: IndexKind

Implementations

impl KeyField

pub fn new<S: ToString>(path: S) -> Self

Create key field from field name

pub fn with_type(self, key: KeyType) -> Self

Add key type

pub fn with_kind(self, kind: IndexKind) -> Self

Add index kind

pub fn set_parent<S: AsRef<str>>(&mut self, parent: S)

Set parent path

This makes key field to be child for parent path

pub fn with_parent<S: AsRef<str>>(self, parent: S) -> Self

Add parent path

This makes key field to be child for parent path

Trait Implementations

impl Clone for KeyField

fn clone(&self) -> KeyField

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyField

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KeyField

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a, S: ToString> From<&'a (S,)> for KeyField

fn from((path): &(S,)) -> Self

Converts to this type from the input type.

impl<'a, S: ToString> From<&'a (S, IndexKind)> for KeyField

fn from((path, kind): &(S, IndexKind)) -> Self

Converts to this type from the input type.

impl<'a, S: ToString> From<&'a (S, IndexKind, KeyType)> for KeyField

fn from((path, kind, key): &(S, IndexKind, KeyType)) -> Self

Converts to this type from the input type.

impl<'a, S: ToString> From<&'a (S, KeyType)> for KeyField

fn from((path, key): &(S, KeyType)) -> Self

Converts to this type from the input type.

impl<'a, S: ToString> From<&'a (S, KeyType, IndexKind)> for KeyField

fn from((path, key, kind): &(S, KeyType, IndexKind)) -> Self

Converts to this type from the input type.

impl<S: ToString> From<(S,)> for KeyField

fn from((path): (S,)) -> Self

Converts to this type from the input type.

impl<S: ToString> From<(S, IndexKind)> for KeyField

fn from((path, kind): (S, IndexKind)) -> Self

Converts to this type from the input type.

impl<S: ToString> From<(S, IndexKind, KeyType)> for KeyField

fn from((path, kind, key): (S, IndexKind, KeyType)) -> Self

Converts to this type from the input type.

impl<S: ToString> From<(S, KeyType)> for KeyField

fn from((path, key): (S, KeyType)) -> Self

Converts to this type from the input type.

impl<S: ToString> From<(S, KeyType, IndexKind)> for KeyField

fn from((path, key, kind): (S, KeyType, IndexKind)) -> Self

Converts to this type from the input type.

impl Into<(String, IndexKind, KeyType)> for KeyField

fn into(self) -> (String, IndexKind, KeyType)

Converts this type into the (usually inferred) input type.

impl Into<(String, KeyType, IndexKind)> for KeyField

fn into(self) -> (String, KeyType, IndexKind)

Converts this type into the (usually inferred) input type.

impl PartialEq for KeyField

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

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 KeyField

impl StructuralPartialEq for KeyField