Struct ipfsapi::IpfsApi

pub struct IpfsApi { /* private fields */ }

Implementations

impl IpfsApi

pub fn cat(&self, hash: &str) -> Result<impl Iterator<Item = u8>, Error>

Retrieves the contents of a file from the IPFS network. Takes a hash and returns an iterator of bytes. The result can be streamed, if the file is large.

let api = IpfsApi::new("127.0.0.1", 5001);

let hello = api.cat("QmWATWQ7fVPP2EFGu71UkfnqhYXDYH566qy47CnJDgvs8u")?;
let hello_string = String::from_utf8(hello.collect())?;
println!("{}", hello_string);

impl IpfsApi

pub fn shutdown(&self) -> Result<(), Error>

Shut down the IPFS daemon This function causes the IPFS daemon to terminate

impl IpfsApi

pub fn version(&self) -> Result<IpfsVersion, Box<dyn Error>>

Get the version from the IPFS daemon.

impl IpfsApi

pub fn block_get(&self, hash: &str) -> Result<impl Iterator<Item = u8>, Error>

Get a raw IPFS block.

Notes

This is a wrapper for the /api/v0/block/get API.

Errors

This function can return an error if the IPFS node is down, or if the block cannot be retrieved.

Examples

let api = IpfsApi::new("127.0.0.1", 5001);

let hash = "QmV8cfu6n4NT5xRr2AHdKxFMTZEJrA44qgrBCr739BN9Wb";
let block = api.block_get(hash).unwrap();
let string = String::from_utf8(block.collect()).unwrap();

assert_eq!(string, "Hello world");

impl IpfsApi

pub fn block_put(&self, data: &[u8]) -> Result<String, Box<dyn Error>>

Puts a raw block into IPFS.

Notes

This is a wrapper for the /api/v0/block/put API.

impl IpfsApi

pub fn name_publish(&self, hash: &str) -> Result<(), Box<dyn Error>>

Publish an IPFS hash in IPNS.

impl IpfsApi

pub fn name_resolve(&self, name: &str) -> Result<String, Box<dyn Error>>

Resolve an IPNS hash or a domain name

let api = IpfsApi::new("127.0.0.1", 5001);
let hash = api.name_resolve("gkbrk.com")?;

println!("{}", hash);

impl IpfsApi

pub fn pin_add(&self, hash: &str) -> Result<Vec<String>, Box<dyn Error>>

Publish an IPFS hash in IPNS.

impl IpfsApi

The main interface of the library The IpfsApi class represents a connection to the local IPFS daemon. It can read and write data to it using http requests to the server.

pub fn new(server: &str, port: u16) -> Self

Creates a new instance of the API

let api = IpfsApi::new("127.0.0.1", 5001);