Struct algorithmia::algo::AlgoResponse

pub struct AlgoResponse {
    pub metadata: AlgoMetadata,
    pub result: AlgoOutput,
    // some fields omitted
}

Successful API response that wraps the AlgoOutput and its Metadata

Fields

metadata: AlgoMetadata

Any metadata associated with the API response

result: AlgoOutput

The algorithm output decoded into an AlgoOutput enum

Methods

impl AlgoResponse

fn into_string(self) -> Option<String>

Return algorithm output as a string (if text or a valid JSON string)

fn into_json(self) -> Option<JsonValue>

Read algorithm output as JsonValue (if JSON of text)

fn into_bytes(self) -> Option<Vec<u8>>

If the algorithm output is Binary, returns the associated byte slice

fn decode<D: Deserialize>(self) -> Result<D>

If the algorithm output is JSON, decode it into a particular type

Trait Implementations

impl FromStr for AlgoResponse

type Err = Error

The associated error which can be returned from parsing.

fn from_str(json_str: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Display for AlgoResponse

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

Formats the value using the given formatter.

impl Read for AlgoResponse

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

unsafe fn initializer(&self) -> Initializer

🔬 This is a nightly-only experimental API. (read_initializer)

Determines if this Reader can work with buffers of uninitialized memory.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

fn chars(self) -> Chars<Self>

🔬 This is a nightly-only experimental API. (io)

the semantics of a partial read/write of where errors happen is currently unclear and may change

Transforms this Read instance to an Iterator over chars.

fn chain<R>(self, next: R) -> Chain<Self, R> where
    R: Read, 

Creates an adaptor which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

Creates an adaptor which will read at most limit bytes from it.