Struct ipfs_api_backend_actix::IpfsClient

pub struct IpfsClient { /* private fields */ }

Trait Implementations

impl Backend for ActixBackend

type HttpRequest = SendClientRequest

type HttpResponse = ClientResponse<Decoder<Payload>>

type Error = Error

fn build_base_request<Req>(
    &self,
    req: Req,
    form: Option<Form<'static>>
) -> Result<Self::HttpRequest, Error> where
    Req: ApiRequest, 

Builds the url for an api call.

fn get_header(res: &Self::HttpResponse, key: HeaderName) -> Option<&HeaderValue>

Get the value of a header from an HTTP response.

fn request_raw<'life0, 'async_trait, Req>(
    &'life0 self,
    req: Req,
    form: Option<Form<'static>>
) -> Pin<Box<dyn Future<Output = Result<(StatusCode, Bytes), Self::Error>> + 'async_trait>> where
    Req: ApiRequest,
    Req: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

Generates a request, and returns the unprocessed response future.

fn response_to_byte_stream(
    res: Self::HttpResponse
) -> BoxStream<Bytes, Self::Error>

fn request_stream<Res, F>(
    &self,
    req: Self::HttpRequest,
    process: F
) -> BoxStream<Res, Self::Error> where
    F: 'static + Send + Fn(Self::HttpResponse) -> BoxStream<Res, Self::Error>, 

Generic method for making a request that expects back a streaming response.

fn process_error_from_body(body: Bytes) -> Self::Error

Builds an Api error from a response body.

fn process_json_response<Res>(
    status: StatusCode,
    body: Bytes
) -> Result<Res, Self::Error> where
    Res: 'static + for<'de> Deserialize<'de> + Send, 

Processes a response that expects a json encoded body, returning an error or a deserialized json response.

fn process_stream_response<D, Res>(
    res: Self::HttpResponse,
    decoder: D
) -> FramedRead<StreamReader<Box<dyn Stream<Item = Result<Bytes, Self::Error>> + Unpin + 'static, Global>>, D> where
    D: Decoder<Item = Res, Error = Error>, 

Processes a response that returns a stream of json deserializable results.

fn request<'life0, 'async_trait, Req, Res>(
    &'life0 self,
    req: Req,
    form: Option<Form<'static>>
) -> Pin<Box<dyn Future<Output = Result<Res, Self::Error>> + 'async_trait, Global>> where
    'life0: 'async_trait,
    Req: ApiRequest + 'async_trait,
    Res: 'static + for<'de> Deserialize<'de> + Send + 'async_trait,
    Self: 'async_trait, 

Generic method for making a request to the Ipfs server, and getting a deserializable response.

fn request_empty<'life0, 'async_trait, Req>(
    &'life0 self,
    req: Req,
    form: Option<Form<'static>>
) -> Pin<Box<dyn Future<Output = Result<(), Self::Error>> + 'async_trait, Global>> where
    'life0: 'async_trait,
    Req: ApiRequest + 'async_trait,
    Self: 'async_trait, 

Generic method for making a request to the Ipfs server, and getting back a response with no body.

fn request_string<'life0, 'async_trait, Req>(
    &'life0 self,
    req: Req,
    form: Option<Form<'static>>
) -> Pin<Box<dyn Future<Output = Result<String, Self::Error>> + 'async_trait, Global>> where
    'life0: 'async_trait,
    Req: ApiRequest + 'async_trait,
    Self: 'async_trait, 

Generic method for making a request to the Ipfs server, and getting back a raw String response.

fn request_stream_bytes(
    &self,
    req: Self::HttpRequest
) -> Box<dyn Stream<Item = Result<Bytes, Self::Error>> + Unpin + 'static, Global>

Generic method for making a request to the Ipfs server, and getting back a raw stream of bytes.

fn request_stream_json<Res>(
    &self,
    req: Self::HttpRequest
) -> Box<dyn Stream<Item = Result<Res, Self::Error>> + Unpin + 'static, Global> where
    Res: 'static + for<'de> Deserialize<'de> + Send, 

Generic method to return a streaming response of deserialized json objects delineated by new line separators.

impl Default for ActixBackend

fn default() -> Self

Creates an IpfsClient connected to the endpoint specified in ~/.ipfs/api. If not found, tries to connect to localhost:5001.

impl TryFromUri for ActixBackend

fn build_with_base_uri(base: Uri) -> Self

Builds a new client from a base URI to the IPFS API.

fn from_str(uri: &str) -> Result<Self, InvalidUri>

Creates a new client from a str.

fn from_host_and_port(
    scheme: Scheme,
    host: &str,
    port: u16
) -> Result<Self, Error>

Creates a new client from a host name and port.

fn from_ipv4(scheme: Scheme, addr: SocketAddrV4) -> Result<Self, Error>

Creates a new client from an IPV4 address and port number.

fn from_ipv6(scheme: Scheme, addr: SocketAddrV6) -> Result<Self, Error>

Creates a new client from an IPV6 addr and port number.

fn from_socket(scheme: Scheme, socket_addr: SocketAddr) -> Result<Self, Error>

Creates a new client from an IP address and port number.

fn from_multiaddr(multiaddr: Multiaddr) -> Result<Self, Error>

Creates a new client from a multiaddr.

fn from_multiaddr_str(multiaddr: &str) -> Result<Self, Error>

Creates a new client from a multiaddr.

fn from_ipfs_config() -> Option<Self>

Creates a new client connected to the endpoint specified in ~/.ipfs/api.