ClientBuilder

Struct ClientBuilder 

Source
pub struct ClientBuilder { /* private fields */ }
Expand description

Builds a new Client instance. By default, configs will be loaded from the default config directories with the following precedence:

  • If the HADOOP_CONF_DIR environment variable is defined, configs will be loaded from ${HADOOP_CONF_DIR}/{core,hdfs}-site.xml
  • If the HADOOP_HOME environment variable is defined, configs will be loaded from ${HADOOP_HOME}/etc/hadoop/{core,hdfs}-site.xml
  • Otherwise no default configs are defined

If no URL is defined, the fs.defaultFS config must be defined and is used as the URL.

§Examples

Create a new client using the fs.defaultFS config

let client = ClientBuilder::new()
    .with_config(vec![("fs.defaultFS", "hdfs://127.0.0.1:9000")])
    .build()
    .unwrap();

Create a new client connecting to a specific URL:

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

Create a new client using a dedicated tokio runtime for spawned tasks and IO operations

let client = ClientBuilder::new()
    .with_url("hdfs://127.0.0.1:9000")
    .with_io_runtime(tokio::runtime::Runtime::new().unwrap())
    .build()
    .unwrap();

Implementations§

Source§

impl ClientBuilder

Source

pub fn new() -> Self

Create a new ClientBuilder

Source

pub fn with_url(self, url: impl Into<String>) -> Self

Set the URL to connect to. Can be the address of a single NameNode, or a logical NameService

Source

pub fn with_config( self, config: impl IntoIterator<Item = (impl Into<String>, impl Into<String>)>, ) -> Self

Set configs to use for the client. The provided configs will override any found in the default config files loaded

Source

pub fn with_io_runtime(self, runtime: impl Into<IORuntime>) -> Self

Use a dedicated tokio runtime for spawned tasks and IO operations. Can either take ownership of a whole Runtime or take a Handle to an externally owned runtime.

Source

pub fn build(self) -> Result<Client>

Create the Client instance from the provided settings

Trait Implementations§

Source§

impl Default for ClientBuilder

Source§

fn default() -> ClientBuilder

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> ErasedDestructor for T
where T: 'static,