Docs.rs
  • json-api-0.4.1
    • json-api 0.4.1
    • Permalink
    • Docs.rs crate page
    • MIT/Apache-2.0
    • Links
    • Repository
    • crates.io
    • Source
    • Owners
    • zacharygolba
    • Dependencies
      • error-chain ^0.11 normal
      • http ^0.1 normal
      • ordermap ^0.3 normal
      • percent-encoding ^1.0 normal
      • serde ^1.0 normal
      • serde_derive ^1.0 normal
      • serde_json ^1.0 normal
      • serde_qs ^0.3 normal
    • Versions
    • 92.71% of the crate is documented
  • Platform
    • i686-pc-windows-msvc
    • i686-unknown-linux-gnu
    • x86_64-apple-darwin
    • x86_64-pc-windows-msvc
    • x86_64-unknown-linux-gnu
  • Feature flags
  • docs.rs
    • About docs.rs
    • Privacy policy
  • Rust
    • Rust website
    • The Book
    • Standard Library API Reference
    • Rust by Example
    • The Cargo Guide
    • Clippy Documentation

Crate json_api

json_api0.4.1

  • All Items

Crate Items

  • Re-exports
  • Modules
  • Macros
  • Structs
  • Enums
  • Traits
  • Functions

Crates

  • json_api

Crate json_api

Source
Expand description

Idiomatic types for building a robust JSON API.

Re-exports§

pub extern crate http;

Modules§

doc
Components of a JSON API document.
error
The Error struct, the Result alias, and other tools to handle failure.
query
An API for working with well-known query parameters.
value
Represent and interact with JSON API values.
view
Low-level utilies for generically rendering a document.

Macros§

resource
A DSL for implementing the Resource trait.

Structs§

Error
The Error type.

Enums§

Document
Represents a compound JSON API document.
Value
Represents any valid JSON API value.

Traits§

Resource
A trait indicating that the given type can be represented as a resource.

Functions§

from_doc
Interpret a Document<T> as a type U.
from_reader
Deserialize a Document<T> from an IO stream of JSON text and then iterpret it as a type U.
from_slice
Deserialize a Document<T> from bytes of JSON text and then iterpret it as a type U.
from_str
Deserialize a Document<T> from a string of JSON text and then iterpret it as a type U.
from_value
Interpret a Value as a type T.
to_doc
Render type T as a Document<U>.
to_string
Render type T as a Document<U> and then serialize it as a string of JSON.
to_string_pretty
Render type T as a Document<U> and then serialize it as a pretty-printed string of JSON.
to_value
Convert a T into a Value.
to_vec
Render type T as a Document<U> and then serialize it as a JSON byte vector.
to_vec_pretty
Render type T as a Document<U> and then serialize it as a pretty-printed JSON byte vector.
to_writer
Render type T as a Document<U> and then serialize it as JSON into the IO stream.
to_writer_pretty
Render type T as a Document<U> and then serialize it as pretty-printed JSON into the IO stream.

Results

Settings
Help
    struct
    json_api::value::fields::Key
    Represents a single member name.
    struct
    json_api::value::collections::map::Keys
    An iterator over the keys of a Map.
    method
    json_api::value::collections::map::Map::keys
    Return an iterator visiting all keys in the order in which …
    method
    json_api::value::collections::map::Map::contains_key
    Returns true if the map contains a value for the specified …
    method
    json_api::doc::NewObject::new
    Key -> NewObject
    Returns a new NewObject.
    method
    json_api::doc::Identifier::new
    Key, String -> Identifier
    Returns a new Identifier.
    method
    json_api::doc::Object::new
    Key, String -> Object
    Returns a new Object.
    method
    json_api::value::fields::Key::clone
    &Key -> Key
    method
    json_api::value::fields::Key::join
    &Key, Key -> Path
    method
    json_api::value::fields::Path::join
    &Path, Key -> Path
    method
    json_api::value::fields::Key::deref
    &Key -> &Deref::Target
    method
    json_api::value::fields::Key::as_ref
    &Key -> &str
    method
    json_api::value::fields::Key::borrow
    &Key -> &str
    method
    json_api::value::fields::Key::to_bytes
    &Key -> Vec<u8>
    method
    json_api::value::fields::Key::eq
    &Key, &Key -> bool
    method
    json_api::value::fields::Key::cmp
    &Key, &Key -> Ordering
    method
    json_api::value::fields::Path::push
    &mut Path, Key -> ()
    Appends a Key to the back of a Path.
    method
    json_api::value::fields::Key::serialize
    &Key, S -> Result
    method
    json_api::value::fields::Key::fmt
    &Key, &mut Formatter -> Result
    method
    json_api::value::fields::Key::partial_cmp
    &Key, &Key -> Option<Ordering>
    method
    json_api::view::Context::fork
    &mut Context, Key, &Key -> Context
    Creates a new child context from self.
    method
    json_api::value::fields::Key::hash
    &Key, &mut __H -> ()
    method
    json_api::view::Context::new
    Key, Option<&Query>, &mut Set<Object> -> Context
    Creates a new, root context.
    trait method
    json_api::Resource::kind
    -> Key
    Returns a key containing the type of resource.
    struct field
    json_api::doc::Identifier::kind
    Identifier -> Key
    Describes resources that share common attributes and …
    struct field
    json_api::doc::Object::kind
    Object -> Key
    Describes resources that share common attributes and …
    struct field
    json_api::doc::NewObject::kind
    NewObject -> Key
    Describes resources that share common attributes and …
    method
    json_api::value::fields::Key::deserialize
    D -> Result<Key>
    method
    json_api::value::fields::Path::pop
    &mut Path -> Option<Key>
    Removes and returns a Key to the back of a Path.
    method
    json_api::value::fields::Key::from_str
    &str -> Result<Key, FromStr::Err>
    method
    json_api::value::fields::Key::clone
    &Key -> Key