Docs.rs
  • json-api-0.4.0
    • json-api 0.4.0
    • Docs.rs crate page
    • MIT/Apache-2.0
    • Links
    • Repository
    • crates.io
    • Source
    • Owners
    • zacharygolba
    • Dependencies
      • error-chain ^0.11
      • http ^0.1
      • ordermap ^0.3
      • percent-encoding ^1.0
      • serde ^1.0
      • serde_derive ^1.0
      • serde_json ^1.0
      • serde_qs ^0.3
    • Versions
  • Go to latest version
  • Platform
    • i686-apple-darwin
    • i686-pc-windows-msvc
    • 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

  • Reexports
  • Modules
  • Macros
  • Structs
  • Enums
  • Traits
  • Functions

Crates

  • json_api

Crate json_api [−] [src]

[−] Expand description

Idiomatic types for building a robust JSON API.

Reexports

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 for String

json_api::Value::StringA string value. 
json_api::value::Value::StringA string value. 
json_api::value::Value::is_stringReturns true if the `Value` is a string. 
json_api::value::StringifyA specializable version of `std::string::ToString`. 
json_api::value::Stringify::stringifyReturns the string representation of the given value. 
json_api::to_stringRender type `T` as a `Document<U>` and then serialize it as a string of JSON. 
json_api::doc::to_stringRender type `T` as a `Document<U>` and then serialize it as a string of JSON. 
json_api::query::to_stringSerialize the given `Query` as a percent encoded query string. 
json_api::to_string_prettyRender type `T` as a `Document<U>` and then serialize it as a pretty-printed string of JSON. 
json_api::doc::to_string_prettyRender type `T` as a `Document<U>` and then serialize it as a pretty-printed string of JSON. 
json_api::value::Number::deserialize_string 

Help

Keyboard Shortcuts

?
Show this help dialog
S
Focus the search field
⇤
Move up in search results
⇥
Move down in search results
⏎
Go to active search result
+
Collapse/expand all sections

Search Tricks

Prefix searches with a type followed by a colon (e.g. fn:) to restrict the search to a given type.

Accepted types are: fn, mod, struct, enum, trait, type, macro, and const.

Search functions by type signature (e.g. vec -> usize or * -> vec)