Struct couchdb::path::DocumentId

pub struct DocumentId(_);

DocumentId comprises one or more URL path segments that, together, identify a document.

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

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

Methods

impl DocumentId

fn new<T: Into<String>>(s: T) -> Self

Constructs a new document id.

fn into_string(self) -> String

Converts the document id into a string.

fn is_normal(&self) -> bool

Returns whether the document id specifies a normal document—i.e., neither a design document nor a local document.

fn into_normal_document_name(self) -> Result<NormalDocumentName, DocumentId>

Tries to convert the document id into a normal document name.

The conversion fails if and only if the document id does not specify a normal document. In other words, the conversion succeeds if and only if the document id begins with neither the _design/ prefix nor the _local prefix.

fn is_design(&self) -> bool

Returns whether the document id specifies a design document—i.e., the document begins with the _design/ prefix.

fn into_design_document_name(self) -> Result<DesignDocumentName, DocumentId>

Tries to convert the document id into a design document name.

fn into_design_document_id(self) -> Result<DesignDocumentId, DocumentId>

Tries to converts the document id into a design document id.

The conversion fails if and only if the document id does not specify a design document. In other words, the conversion succeeds if and only if the document id begins with the _design/ prefix.

fn is_local(&self) -> bool

Returns whether the document id specifies a local document—i.e., the document begins with the _local/ prefix.

fn into_local_document_name(self) -> Result<LocalDocumentName, DocumentId>

Tries to convert the document id into a local document name.

The conversion fails if and only if the document id does not specify a local document. In other words, the conversion succeeds if and only if the document id begins with the _local/ prefix.

Trait Implementations

impl Clone for DocumentId

fn clone(&self) -> DocumentId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentId

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

Formats the value using the given formatter.

impl Default for DocumentId

fn default() -> DocumentId

Returns the "default value" for a type.

impl Eq for DocumentId

impl Hash for DocumentId

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 DocumentId

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

This method returns an Ordering between self and other.

impl PartialEq for DocumentId

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

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

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

This method tests for !=.

impl PartialOrd for DocumentId

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

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

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

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

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

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

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

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

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

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

impl AsRef<str> for DocumentId

fn as_ref(&self) -> &str

Performs the conversion.

impl Display for DocumentId

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

Formats the value using the given formatter.

impl<'a> From<&'a str> for DocumentId

fn from(s: &'a str) -> Self

Performs the conversion.

impl From<String> for DocumentId

fn from(s: String) -> Self

Performs the conversion.

impl From<DesignDocumentId> for DocumentId

fn from(ddoc_id: DesignDocumentId) -> Self

Performs the conversion.

impl From<NormalDocumentName> for DocumentId

fn from(doc_name: NormalDocumentName) -> Self

Performs the conversion.

impl From<DesignDocumentName> for DocumentId

fn from(ddoc_name: DesignDocumentName) -> Self

Performs the conversion.

impl From<LocalDocumentName> for DocumentId

fn from(ldoc_name: LocalDocumentName) -> Self

Performs the conversion.