Struct couchdb::path::DesignDocumentId

pub struct DesignDocumentId(_);

DesignDocumentId comprises URL path segments that, together, identify a design document.

For example, given the document path /db/_design/doc, the design document id is _design/doc.

DesignDocumentId is a special form of DocumentId. All design document ids are document ids, but not all document ids are design document ids.

For more information about path-related types, see the module-level documentation.

Methods

impl DesignDocumentId

fn parse(s: &str) -> Result<Self, Error>

Tries to construct a design document id from a string.

fn into_string(self) -> String

Converts the design document id into a String.

fn into_document_id(self) -> DocumentId

Converts the design document id into a general document id.

fn into_design_document_name(self) -> DesignDocumentName

Converts the design document id into a design document name.

Trait Implementations

impl Clone for DesignDocumentId

fn clone(&self) -> DesignDocumentId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DesignDocumentId

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Default for DesignDocumentId

fn default() -> DesignDocumentId

Returns the "default value" for a type.

impl Eq for DesignDocumentId

impl Hash for DesignDocumentId

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl Ord for DesignDocumentId

fn cmp(&self, __arg_0: &DesignDocumentId) -> Ordering

This method returns an Ordering between self and other.

impl PartialEq for DesignDocumentId

fn eq(&self, __arg_0: &DesignDocumentId) -> bool

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

fn ne(&self, __arg_0: &DesignDocumentId) -> bool

This method tests for !=.

impl PartialOrd for DesignDocumentId

fn partial_cmp(&self, __arg_0: &DesignDocumentId) -> Option<Ordering>

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

fn lt(&self, __arg_0: &DesignDocumentId) -> bool

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

fn le(&self, __arg_0: &DesignDocumentId) -> bool

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

fn gt(&self, __arg_0: &DesignDocumentId) -> bool

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

fn ge(&self, __arg_0: &DesignDocumentId) -> bool

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

impl AsRef<str> for DesignDocumentId

fn as_ref(&self) -> &str

Performs the conversion.

impl Display for DesignDocumentId

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

Formats the value using the given formatter.

impl FromStr for DesignDocumentId

type Err = Error

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 From<DesignDocumentName> for DesignDocumentId

fn from(ddoc_name: DesignDocumentName) -> Self

Performs the conversion.

impl<'a> Deserialize<'a> for DesignDocumentId

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'a>, 

Deserialize this value from the given Serde deserializer.