Struct Rtc

Source

pub struct Rtc(Arc<Mutex<File>>);

Expand description

Interface to the hardware real-time clock device.

Rtc provides access to both time and alarm functionality of the RTC. Operations are serialized via an internal mutex to ensure thread-safe access to the underlying device file.

Tuple Fields§

§0: Arc<Mutex<File>>

Implementations§

Source §

impl Rtc

Source

pub fn new<P: AsRef<Path>>(path: P) -> Result<Rtc, Error>

Opens the RTC device and creates a new interface handle.

§Arguments

path - Path to the RTC device file (typically /dev/rtc0 or /dev/rtc)

§Returns

A new Rtc handle on success, or an error if the device cannot be opened.

§Example

let rtc = Rtc::new("/dev/rtc0")?;

Source

pub fn alarm(&self) -> Result<RtcWkalrm, Error>

Reads the current alarm settings from the hardware.

Returns information about the wake alarm, including whether it is enabled and any pending alarm status. The alarm time is stored as RtcWkalrm.

§Returns

Alarm settings on success, or an error if the ioctl fails or the lock is poisoned.

Source

pub fn set_alarm(&self, wake_time: DateTime<Utc>) -> Result<i32, Error>

Programs the hardware to wake at the specified time.

Enables a single-shot alarm that will fire at the given UTC time. If an alarm is already scheduled, it is replaced.

§Arguments

wake_time - The UTC time when the alarm should fire

§Returns

A status code on success (typically 0 if supported), or an error if the ioctl fails or the lock is poisoned.

Source

pub fn disable_alarm(&self) -> Result<i32, Error>

Disables the hardware alarm.

Clears any pending alarm without affecting the alarm time itself.

§Returns

A status code on success (typically 0 if supported), or an error if the ioctl fails or the lock is poisoned.

Source

pub fn read_time(&self) -> Result<DateTime<Utc>, Error>

Reads the current time from the hardware RTC.

§Returns

The current UTC time on success, or an error if the ioctl fails, the RTC fields are invalid, or the lock is poisoned.

§Example

let now = rtc.read_time()?;
println!("RTC time: {}", now);

Source

pub fn set_time(&self, time: DateTime<Utc>) -> Result<(), Error>

Sets the hardware RTC to the specified time.

Updates the RTC with a new UTC time. This typically requires elevated privileges.

§Arguments

time - The UTC time to set

§Returns

Success with no value, or an error if the ioctl fails or the lock is poisoned.

§Example

rtc.set_time(Utc::now())?;

Trait Implementations§

Source §

impl Clone for Rtc

Source §

fn clone(&self) -> Self

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl UnwindSafe for Rtc

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> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.

§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.

§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.

§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.

§

impl<T> DowncastSend for T
where T: Any + Send,

§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.

§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_sync(self: Box<T>) -> Box<dyn Any + Send + Sync>

Converts Box<Trait> (where Trait: DowncastSync) to Box<dyn Any + Send + Sync>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Converts Arc<Trait> (where Trait: DowncastSync) to Arc<Any>, which can then be downcast into Arc<ConcreteType> where ConcreteType implements Trait.

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into 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> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

§