Struct UserInfo 

pub struct UserInfo {
    pub username: String,
    pub home_dir: PathBuf,
    pub shell: PathBuf,
    pub uid: Option<u32>,
    pub gid: Option<u32>,
    pub groups: Vec<u32>,
    pub display_name: Option<String>,
}

Information about an authenticated user.

This struct contains user information that is commonly needed after successful authentication, both for client-side display and server-side session setup.

Examples

use bssh::shared::auth_types::UserInfo;
use std::path::PathBuf;

let user = UserInfo::new("johndoe")
    .with_home_dir("/home/johndoe")
    .with_shell("/bin/bash")
    .with_uid(1000)
    .with_gid(1000);

assert_eq!(user.username, "johndoe");

Fields

username: String

The username of the authenticated user.

home_dir: PathBuf

The user’s home directory.

shell: PathBuf

The user’s default shell.

uid: Option<u32>

The user’s numeric user ID (Unix-specific).

gid: Option<u32>

The user’s primary group ID (Unix-specific).

groups: Vec<u32>

Additional group IDs the user belongs to (Unix-specific).

display_name: Option<String>

Display name or full name of the user.

Implementations

impl UserInfo

pub fn new(username: impl Into<String>) -> Self

Create a new UserInfo with just a username.

Other fields are initialized to sensible defaults:

• home_dir: /home/<username> on Unix, empty on other platforms
• shell: /bin/sh on Unix, empty on other platforms
• uid/gid: None

Arguments

• username - The username

Examples

use bssh::shared::auth_types::UserInfo;

let user = UserInfo::new("alice");
assert_eq!(user.username, "alice");

pub fn with_home_dir(self, path: impl Into<PathBuf>) -> Self

Set the home directory.

pub fn with_shell(self, path: impl Into<PathBuf>) -> Self

Set the default shell.

pub fn with_uid(self, uid: u32) -> Self

Set the user ID.

pub fn with_gid(self, gid: u32) -> Self

Set the primary group ID.

pub fn with_groups(self, groups: impl Into<Vec<u32>>) -> Self

Set the additional group IDs.

pub fn with_display_name(self, name: impl Into<String>) -> Self

Set the display name.

Trait Implementations

impl Clone for UserInfo

fn clone(&self) -> UserInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UserInfo

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

Formats the value using the given formatter.

impl Eq for UserInfo

impl PartialEq for UserInfo

fn eq(&self, other: &UserInfo) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for UserInfo