Struct PTMUser

pub struct PTMUser { /* private fields */ }

Handle to the PTM:User service.

Implementations

impl PTMUser

pub fn new() -> Result<Self>

Initialize a new service handle.

Errors

This function will return an error if the service was unable to be initialized. Since this service requires no special or elevated permissions, errors are rare in practice.

Example

use ctru::services::ptm::user::PTMUser;

let ptmu = PTMUser::new()?;

pub fn shell_state(&self) -> Result<ShellState>

Returns whether the console’s clamshell is closed or open.

Example

use ctru::services::ptm::user::{PTMUser, ShellState};

let ptmu = PTMUser::new()?;

let state = ptmu.shell_state()?;

match state {
    ShellState::Closed => println!("The shell is closed! How are you able to read this?"),
    ShellState::Open => println!("The shell is open! That might seem obvious to you."),
}

pub fn battery_level(&self) -> Result<BatteryLevel>

Returns the console’s current battery charge level.

Example

use ctru::services::ptm::user::{PTMUser, BatteryLevel};

let ptmu = PTMUser::new()?;

let charge = ptmu.battery_level()?;

if charge <= BatteryLevel::Low {
    println!("You should put the console to charge!");
}

pub fn is_charging(&self) -> Result<bool>

Returns whether the console is currently charging its battery.

Example

use ctru::services::ptm::user::PTMUser;

let ptmu = PTMUser::new()?;

let is_charging = ptmu.is_charging()?;

if is_charging {
    println!("That is one juicy power line.");
}

pub fn step_count(&self) -> Result<u32>

Returns the console’s total step count.

Example

use ctru::services::ptm::user::PTMUser;

let ptmu = PTMUser::new()?;

let steps = ptmu.step_count()?;

println!("You accumulated {steps} steps. Don't stop moving!");