Struct uhppote_rs::Device

source · [−]

pub struct Device<'a> { /* private fields */ }

Implementations

source

impl<'a> Device<'a>

source

pub fn add_card(&self, card: Card) -> Result<()>

Add a Card to the Device.

source

pub fn add_task(&self, task: Task) -> Result<()>

Add a Task to the system.

source

pub fn clear_cards(&self) -> Result<()>

Remove all Cards from the Device.

source

pub fn clear_tasks(&self) -> Result<()>

Remove all Tasks from the Device.

source

pub fn clear_time_profiles(&self) -> Result<()>

Remove all TimeProfiles from the Device.

source

pub fn delete_card(&self, number: u32) -> Result<()>

Remove a Card from the Device.

source

pub fn get_card_by_id(&self, id: u32) -> Result<Card>

Get a specific Card by its ID.

source

pub fn get_card_by_index(&self, index: u32) -> Result<Card>

Get a specific Card by its index.

source

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

Get the number of Cards from the Device.

source

pub fn get_config(&self) -> Result<DeviceConfig>

Get a DeviceConfig for a the Device.

source

pub fn get_door_control(&self, door: u8) -> Result<DoorControl>

Get a DoorControl for a specific door. Note that doors are addressed 1-4, not 0-3.

source

pub fn get_event(&self, index: u32) -> Result<Event>

Get an Event by its index.

source

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

Get the event index the Device

source

pub fn get_listener(&self) -> Result<SocketAddr>

Get what listener (IP:PORT) is set on the Device. This is where the the Device will send Status messages to over UDP.

source

pub fn get_status(&self) -> Result<Status>

Get the Status of the Device.

source

pub fn get_time(&self) -> Result<NaiveDateTime>

Get the current time of the Device.

source

pub fn get_time_profile(&self, profile_id: u8) -> Result<TimeProfile>

Get the TimeProfile by ID.

source

pub fn open_door(&self, door: u8) -> Result<()>

Open a door. Note that doors are addressed 1-4, not 0-3.

source

pub fn refresh_task_list(&self) -> Result<()>

Refresh the task list of the Device.

source

pub fn set_door_control_state(
 &self,
 door: u8,
 state: DoorControl,
 delay: Duration
) -> Result<DoorControl>

Set the DoorControl for a specific door. Note that the delay is in seconds and can maximally be 255.

source

pub fn set_event_index(&self, index: u32) -> Result<()>

Set the event index the Device will use.

source

pub fn set_listener(&self, address: Ipv4Addr, port: u16) -> Result<()>

Set the listener (IP:PORT) the Device will use to send Status messages to over UDP.

source

pub fn set_network_config(
 &self,
 address: Ipv4Addr,
 subnet: Ipv4Addr,
 gateway: Ipv4Addr
) -> Result<()>

Set IP address, subnet mask and gateway for the Device.

source

pub fn enable_record_special_events(&self, enable: bool) -> Result<()>

Enable the recording of special events.

source

pub fn set_time(&self, datetime: NaiveDateTime) -> Result<NaiveDateTime>

Set the local time of the Device.

source

pub fn add_or_update_time_profile(&self, profile: TimeProfile) -> Result<()>

Add or update new TimeProfile to the Device.

Trait Implementations

source

impl<'a> Debug for Device<'a>

source

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl<'a> RefUnwindSafe for Device<'a>

impl<'a> Send for Device<'a>

impl<'a> Sync for Device<'a>

impl<'a> Unpin for Device<'a>

impl<'a> UnwindSafe for Device<'a>

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct uhppote_rs::Device

Implementations

impl<'a> Device<'a>

pub fn add_card(&self, card: Card) -> Result<()>

pub fn add_task(&self, task: Task) -> Result<()>

pub fn clear_cards(&self) -> Result<()>

pub fn clear_tasks(&self) -> Result<()>

pub fn clear_time_profiles(&self) -> Result<()>

pub fn delete_card(&self, number: u32) -> Result<()>

pub fn get_card_by_id(&self, id: u32) -> Result<Card>

pub fn get_card_by_index(&self, index: u32) -> Result<Card>

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

pub fn get_config(&self) -> Result<DeviceConfig>

pub fn get_door_control(&self, door: u8) -> Result<DoorControl>

pub fn get_event(&self, index: u32) -> Result<Event>

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

pub fn get_listener(&self) -> Result<SocketAddr>

pub fn get_status(&self) -> Result<Status>

pub fn get_time(&self) -> Result<NaiveDateTime>

pub fn get_time_profile(&self, profile_id: u8) -> Result<TimeProfile>

pub fn open_door(&self, door: u8) -> Result<()>

pub fn refresh_task_list(&self) -> Result<()>

pub fn set_door_control_state( &self, door: u8, state: DoorControl, delay: Duration) -> Result<DoorControl>

pub fn set_event_index(&self, index: u32) -> Result<()>

pub fn set_listener(&self, address: Ipv4Addr, port: u16) -> Result<()>

pub fn set_network_config( &self, address: Ipv4Addr, subnet: Ipv4Addr, gateway: Ipv4Addr) -> Result<()>

pub fn enable_record_special_events(&self, enable: bool) -> Result<()>

pub fn set_time(&self, datetime: NaiveDateTime) -> Result<NaiveDateTime>

pub fn add_or_update_time_profile(&self, profile: TimeProfile) -> Result<()>

Trait Implementations

impl<'a> Debug for Device<'a>

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

Auto Trait Implementations

impl<'a> RefUnwindSafe for Device<'a>

impl<'a> Send for Device<'a>

impl<'a> Sync for Device<'a>

impl<'a> Unpin for Device<'a>

impl<'a> UnwindSafe for Device<'a>

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

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

type Error = Infallible

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

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

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

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

pub fn set_door_control_state(
&self,
door: u8,
state: DoorControl,
delay: Duration
) -> Result<DoorControl>

pub fn set_network_config(
&self,
address: Ipv4Addr,
subnet: Ipv4Addr,
gateway: Ipv4Addr
) -> Result<()>

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

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

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

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

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

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