Struct couchdb::path::DocumentPath

pub struct DocumentPath { /* fields omitted */ }

DocumentPath is the full URL path of a document.

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

Methods

impl DocumentPath

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

Tries to construct a document path from a string.

fn database_name(&self) -> &DatabaseName

Borrows the path's database name.

fn document_id(&self) -> &DocumentId

Borrows the path's document id.

fn with_attachment_name<T: Into<AttachmentName>>(
    self,
    att_name: T
) -> AttachmentPath

Joins the path with an attachment name to construct an attachment path.

Trait Implementations

impl Clone for DocumentPath

fn clone(&self) -> DocumentPath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentPath

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

Formats the value using the given formatter.

impl Default for DocumentPath

fn default() -> DocumentPath

Returns the "default value" for a type.

impl Eq for DocumentPath

impl Hash for DocumentPath

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 DocumentPath

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

This method returns an Ordering between self and other.

impl PartialEq for DocumentPath

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

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

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

This method tests for !=.

impl PartialOrd for DocumentPath

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

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

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

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

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

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

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

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

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

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

impl FromStr for DocumentPath

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 Display for DocumentPath

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

Formats the value using the given formatter.