Struct ClientBuilder 

pub struct ClientBuilder { /* private fields */ }

Tokio-based asynchronous client API.

This is the default mode (feature async). Builder for Client.

Implementations

impl ClientBuilder

pub fn new(target: SocketAddr) -> Self

Create a new builder.

pub fn username_bytes(self, username: impl Into<Vec<u8>>) -> Self

Set the username (bytes).

IPMI usernames are ASCII in most deployments, but the protocol treats them as raw bytes.

pub fn username(self, username: impl AsRef<str>) -> Self

Set the username (UTF-8 string). This is a convenience wrapper around Self::username_bytes.

Examples found in repository

examples/tokio_get_device_id.rs (line 17)

    pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
        // Example:
        //   cargo run --example tokio_get_device_id -- 192.168.1.10:623 admin password
        let mut args = std::env::args().skip(1);
        let target = args.next().ok_or("missing <host:port>")?.parse()?;
        let username = args.next().ok_or("missing <username>")?;
        let password = args.next().ok_or("missing <password>")?;

        let client = Client::builder(target)
            .username(username)
            .password(password)
            .privilege_level(PrivilegeLevel::Administrator)
            .timeout(Duration::from_secs(2))
            .retries(3)
            .build()
            .await?;

        let device_id = client.get_device_id().await?;
        println!("Device: {device_id:?}");

        Ok(())
    }

pub fn password_bytes(self, password: impl Into<Vec<u8>>) -> Self

Set the password (bytes).

pub fn password(self, password: impl AsRef<str>) -> Self

Set the password (UTF-8 string). This is a convenience wrapper around Self::password_bytes.

Examples found in repository

examples/tokio_get_device_id.rs (line 18)

    pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
        // Example:
        //   cargo run --example tokio_get_device_id -- 192.168.1.10:623 admin password
        let mut args = std::env::args().skip(1);
        let target = args.next().ok_or("missing <host:port>")?.parse()?;
        let username = args.next().ok_or("missing <username>")?;
        let password = args.next().ok_or("missing <password>")?;

        let client = Client::builder(target)
            .username(username)
            .password(password)
            .privilege_level(PrivilegeLevel::Administrator)
            .timeout(Duration::from_secs(2))
            .retries(3)
            .build()
            .await?;

        let device_id = client.get_device_id().await?;
        println!("Device: {device_id:?}");

        Ok(())
    }

pub fn bmc_key_bytes(self, kg: impl Into<Vec<u8>>) -> Self

Set the optional BMC key (Kg) for “two-key” logins.

If not set, the password key is used (“one-key” login), which is common in many BMC default configs.

pub fn bmc_key(self, kg: impl AsRef<str>) -> Self

Set the optional BMC key (Kg) for “two-key” logins (UTF-8 string).

pub fn privilege_level(self, level: PrivilegeLevel) -> Self

Set requested session privilege level.

Examples found in repository

examples/tokio_get_device_id.rs (line 19)

    pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
        // Example:
        //   cargo run --example tokio_get_device_id -- 192.168.1.10:623 admin password
        let mut args = std::env::args().skip(1);
        let target = args.next().ok_or("missing <host:port>")?.parse()?;
        let username = args.next().ok_or("missing <username>")?;
        let password = args.next().ok_or("missing <password>")?;

        let client = Client::builder(target)
            .username(username)
            .password(password)
            .privilege_level(PrivilegeLevel::Administrator)
            .timeout(Duration::from_secs(2))
            .retries(3)
            .build()
            .await?;

        let device_id = client.get_device_id().await?;
        println!("Device: {device_id:?}");

        Ok(())
    }

pub fn timeout(self, timeout: Duration) -> Self

Set UDP read timeout.

Examples found in repository

examples/tokio_get_device_id.rs (line 20)

    pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
        // Example:
        //   cargo run --example tokio_get_device_id -- 192.168.1.10:623 admin password
        let mut args = std::env::args().skip(1);
        let target = args.next().ok_or("missing <host:port>")?.parse()?;
        let username = args.next().ok_or("missing <username>")?;
        let password = args.next().ok_or("missing <password>")?;

        let client = Client::builder(target)
            .username(username)
            .password(password)
            .privilege_level(PrivilegeLevel::Administrator)
            .timeout(Duration::from_secs(2))
            .retries(3)
            .build()
            .await?;

        let device_id = client.get_device_id().await?;
        println!("Device: {device_id:?}");

        Ok(())
    }

pub fn retries(self, attempts: u32) -> Self

Set number of send attempts per request (including the first attempt).

Examples found in repository

examples/tokio_get_device_id.rs (line 21)

    pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
        // Example:
        //   cargo run --example tokio_get_device_id -- 192.168.1.10:623 admin password
        let mut args = std::env::args().skip(1);
        let target = args.next().ok_or("missing <host:port>")?.parse()?;
        let username = args.next().ok_or("missing <username>")?;
        let password = args.next().ok_or("missing <password>")?;

        let client = Client::builder(target)
            .username(username)
            .password(password)
            .privilege_level(PrivilegeLevel::Administrator)
            .timeout(Duration::from_secs(2))
            .retries(3)
            .build()
            .await?;

        let device_id = client.get_device_id().await?;
        println!("Device: {device_id:?}");

        Ok(())
    }

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

Establish the session and build the Client.

Examples found in repository

examples/tokio_get_device_id.rs (line 22)

    pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
        // Example:
        //   cargo run --example tokio_get_device_id -- 192.168.1.10:623 admin password
        let mut args = std::env::args().skip(1);
        let target = args.next().ok_or("missing <host:port>")?.parse()?;
        let username = args.next().ok_or("missing <username>")?;
        let password = args.next().ok_or("missing <password>")?;

        let client = Client::builder(target)
            .username(username)
            .password(password)
            .privilege_level(PrivilegeLevel::Administrator)
            .timeout(Duration::from_secs(2))
            .retries(3)
            .build()
            .await?;

        let device_id = client.get_device_id().await?;
        println!("Device: {device_id:?}");

        Ok(())
    }

Trait Implementations

impl Debug for ClientBuilder

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

Formats the value using the given formatter.