Struct couchdb::path::ViewId

pub struct ViewId(_);

ViewId comprises URL path segments that combine a design document name and a view name.

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

An application can use ViewId when specifying a view filter by, for example, sending an HTTP request to GET /{db}/_changes?filter=_view&view=doc/view, where doc/view is a view id.

NOTE: As of version 1.6.1, the CouchDB server does not support view filters where either the design document name or view name contain a slash character (/). As such, ViewId makes no attempt to correctly percent-encode the names.

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

Methods

impl ViewId

fn new<T, U>(ddoc_name: T, view_name: U) -> Self where
    T: Into<DesignDocumentName>,
    U: Into<ViewName>, 

Constructs a view id from a design document name and a view name.

fn into_string(self) -> String

Converts the view id into a String.

Trait Implementations

impl Clone for ViewId

fn clone(&self) -> ViewId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ViewId

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

Formats the value using the given formatter.

impl Default for ViewId

fn default() -> ViewId

Returns the "default value" for a type.

impl Eq for ViewId

impl Hash for ViewId

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 ViewId

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

This method returns an Ordering between self and other.

impl PartialEq for ViewId

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

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

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

This method tests for !=.

impl PartialOrd for ViewId

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

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

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

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

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

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

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

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

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

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

impl AsRef<str> for ViewId

fn as_ref(&self) -> &str

Performs the conversion.

impl Display for ViewId

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

Formats the value using the given formatter.