Struct indradb::Identifier

pub struct Identifier(_);

A string that must be less than 256 characters long, and can only contain letters, numbers, dashes and underscores. This is used for vertex and edge types, as well as property names.

Implementations

impl Identifier

pub fn new<S: Into<String>>(s: S) -> ValidationResult<Self>

Constructs a new identifier.

Arguments

• s: The identifier value.

Errors

Returns a ValidationError if the identifier is longer than 255 characters, or has invalid characters.

pub unsafe fn new_unchecked<S: Into<String>>(s: S) -> Self

Constructs a new identifier, without any checks that it is valid.

Arguments

• s: The identifier value.

Safety

This function is marked unsafe because there’s no verification that the identifier is valid.

pub fn as_str(&self) -> &str

Gets a reference to the identifier value.

pub fn into_string(self) -> String

Converts the identifier into a string with the underlying value.

Trait Implementations

impl Clone for Identifier

fn clone(&self) -> Identifier

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Identifier

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

Formats the value using the given formatter.

impl Default for Identifier

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Identifier

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

Deserialize this value from the given Serde deserializer.

impl FromStr for Identifier

type Err = ValidationError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Identifier

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Identifier

fn cmp(&self, other: &Identifier) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Identifier> for Identifier

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<Identifier> for Identifier

fn partial_cmp(&self, other: &Identifier) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Identifier

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

Serialize this value into the given Serde serializer.

impl ToString for Identifier

fn to_string(&self) -> String

Converts the given value to a String.

impl TryFrom<String> for Identifier

type Error = ValidationError

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Identifier

impl StructuralEq for Identifier

impl StructuralPartialEq for Identifier