Struct HdfsObjectStore

pub struct HdfsObjectStore { /* private fields */ }

Interface for Hadoop Distributed File System.

Implementations

impl HdfsObjectStore

pub fn new(client: Client) -> Self

Creates a new HdfsObjectStore from an existing hdfs-native Client

use hdfs_native::ClientBuilder;
let client = ClientBuilder::new().with_url("hdfs://127.0.0.1:9000").build().unwrap();
let store = HdfsObjectStore::new(client);

pub fn with_url(url: &str) -> Result<Self>

👎Deprecated since 0.15.0: Use HdfsObjectStoreBuilder instead

Creates a new HdfsObjectStore using the specified URL

Connect to a NameNode

let store = HdfsObjectStore::with_url("hdfs://127.0.0.1:9000")?;

pub fn with_config(url: &str, config: HashMap<String, String>) -> Result<Self>

👎Deprecated since 0.15.0: Use HdfsObjectStoreBuilder instead

Creates a new HdfsObjectStore using the specified URL and Hadoop configs.

Connect to a NameService

let config = HashMap::from([
    ("dfs.ha.namenodes.ns".to_string(), "nn1,nn2".to_string()),
    ("dfs.namenode.rpc-address.ns.nn1".to_string(), "nn1.example.com:9000".to_string()),
    ("dfs.namenode.rpc-address.ns.nn2".to_string(), "nn2.example.com:9000".to_string()),
]);
let store = HdfsObjectStore::with_config("hdfs://ns", config)?;

Trait Implementations

impl Clone for HdfsObjectStore

fn clone(&self) -> HdfsObjectStore

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HdfsObjectStore

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

Formats the value using the given formatter.

impl Display for HdfsObjectStore

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

Formats the value using the given formatter.

impl From<Client> for HdfsObjectStore

fn from(value: Client) -> Self

Converts to this type from the input type.

impl ObjectStore for HdfsObjectStore

fn put_opts<'life0, 'life1, 'async_trait>( &'life0 self, location: &'life1 Path, payload: PutPayload, opts: PutOptions, ) -> Pin<Box<dyn Future<Output = Result<PutResult>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Save the provided bytes to the specified location

To make the operation atomic, we write to a temporary file .{filename}.tmp.{i} and rename on a successful write, where i is an integer that is incremented until a non-existent file is found.

fn put_multipart_opts<'life0, 'life1, 'async_trait>( &'life0 self, location: &'life1 Path, _opts: PutMultipartOpts, ) -> Pin<Box<dyn Future<Output = Result<Box<dyn MultipartUpload>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Create a multipart writer that writes to a temporary file in a background task, and renames to the final destination on complete.

fn get_opts<'life0, 'life1, 'async_trait>( &'life0 self, location: &'life1 Path, options: GetOptions, ) -> Pin<Box<dyn Future<Output = Result<GetResult>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Reads data for the specified location.

fn head<'life0, 'life1, 'async_trait>( &'life0 self, location: &'life1 Path, ) -> Pin<Box<dyn Future<Output = Result<ObjectMeta>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Return the metadata for the specified location

fn delete<'life0, 'life1, 'async_trait>( &'life0 self, location: &'life1 Path, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Delete the object at the specified location.

fn list(&self, prefix: Option<&Path>) -> BoxStream<'static, Result<ObjectMeta>>

List all the objects with the given prefix.

Prefixes are evaluated on a path segment basis, i.e. foo/bar/ is a prefix of foo/bar/x but not of foo/bar_baz/x.

Note: the order of returned ObjectMeta is not guaranteed

fn list_with_delimiter<'life0, 'life1, 'async_trait>( &'life0 self, prefix: Option<&'life1 Path>, ) -> Pin<Box<dyn Future<Output = Result<ListResult>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

List objects with the given prefix and an implementation specific delimiter. Returns common prefixes (directories) in addition to object metadata.

Prefixes are evaluated on a path segment basis, i.e. foo/bar/ is a prefix of foo/bar/x but not of foo/bar_baz/x.

fn rename<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, from: &'life1 Path, to: &'life2 Path, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Renames a file. This operation is guaranteed to be atomic.

fn rename_if_not_exists<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, from: &'life1 Path, to: &'life2 Path, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Renames a file only if the distination doesn’t exist. This operation is guaranteed to be atomic.

fn copy<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, from: &'life1 Path, to: &'life2 Path, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Copy an object from one path to another in the same object store.

If there exists an object at the destination, it will be overwritten.

fn copy_if_not_exists<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, from: &'life1 Path, to: &'life2 Path, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Copy an object from one path to another, only if destination is empty.

Will return an error if the destination already has an object.

Performs an atomic operation if the underlying object storage supports it. If atomic operations are not supported by the underlying object storage (like S3) it will return an error.

fn put<'life0, 'life1, 'async_trait>( &'life0 self, location: &'life1 Path, payload: PutPayload, ) -> Pin<Box<dyn Future<Output = Result<PutResult, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Save the provided bytes to the specified location

fn put_multipart<'life0, 'life1, 'async_trait>( &'life0 self, location: &'life1 Path, ) -> Pin<Box<dyn Future<Output = Result<Box<dyn MultipartUpload>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Perform a multipart upload

fn get<'life0, 'life1, 'async_trait>( &'life0 self, location: &'life1 Path, ) -> Pin<Box<dyn Future<Output = Result<GetResult, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Return the bytes that are stored at the specified location.

fn get_range<'life0, 'life1, 'async_trait>( &'life0 self, location: &'life1 Path, range: Range<u64>, ) -> Pin<Box<dyn Future<Output = Result<Bytes, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Return the bytes that are stored at the specified location in the given byte range.

fn get_ranges<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, location: &'life1 Path, ranges: &'life2 [Range<u64>], ) -> Pin<Box<dyn Future<Output = Result<Vec<Bytes>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: 'async_trait,

Return the bytes that are stored at the specified location in the given byte ranges

fn delete_stream<'a>( &'a self, locations: Pin<Box<dyn Stream<Item = Result<Path, Error>> + Send + 'a>>, ) -> Pin<Box<dyn Stream<Item = Result<Path, Error>> + Send + 'a>>

Delete all the objects at the specified locations

fn list_with_offset( &self, prefix: Option<&Path>, offset: &Path, ) -> Pin<Box<dyn Stream<Item = Result<ObjectMeta, Error>> + Send>>

List all the objects with the given prefix and a location greater than offset