Struct uhppote_rs::Device

source · [−]

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

Implementations

source

impl<'a> Device<'a>

source

pub fn new(u: &'a mut UHPPOTE, id: u32) -> Device<'a>

source

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

Get a DeviceConfig for a device id.

source

pub fn set_address(
 &mut self,
 address: String,
 subnet: String,
 gateway: String
) -> Result<()>

Set the IP address, subnet mask, and gateway of a device.

source

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

Get the Status of a device.

source

pub fn get_date_time(&mut self) -> Result<NaiveDateTime>

Get the NaiveDateTime of the device.

source

pub fn set_date_time(&mut self, time: NaiveDateTime) -> Result<()>

Set the date and time of the device.

source

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

Return the IP address and port to which the selected controller sends events.

source

pub fn set_listener(&mut self, listener: SocketAddr) -> Result<()>

source

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

Get the DoorControl (DoorControlMode and delay) of a door. Note that the first door id is 1, not 0.

source

pub fn set_door_control(
 &mut self,
 door: u8,
 mode: DoorControlMode,
 delay: u8
) -> Result<()>

Set the DoorControl (DoorControlMode and delay) of a door.Note that the first door id is 1, not 0.

source

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

Open a door. Note that the first door id is 1, not 0.

source

pub fn get_cards(&mut self) -> Result<i32>

Get all the amount of cards in the system.

source

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

Get a specific Card by its index.

source

pub fn get_card(&mut self, card_number: u32) -> Result<Card>

Get a Card by its card number.

source

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

Add a Card to the system.

source

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

Remove a Card from the system.

source

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

Get the event index.

source

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

Set the event index.

source

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

Get an Event by its index.

source

pub fn record_special_events(&mut self, enabled: bool) -> Result<()>

Enable/disable recording of special events

source

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

Get a TimeProfile by its index.

source

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

Set a TimeProfile by its index. Note that profile ID has to be larger than 1.

source

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

Clear all TimeProfiles.

source

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

Add a Task to the system.

source

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

Refresh the task list.

source

pub fn clear_task_list(&mut self) -> Result<()>

Clear the task list

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 new(u: &'a mut UHPPOTE, id: u32) -> Device<'a>

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

pub fn set_address( &mut self, address: String, subnet: String, gateway: String) -> Result<()>

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

pub fn get_date_time(&mut self) -> Result<NaiveDateTime>

pub fn set_date_time(&mut self, time: NaiveDateTime) -> Result<()>

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

pub fn set_listener(&mut self, listener: SocketAddr) -> Result<()>

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

pub fn set_door_control( &mut self, door: u8, mode: DoorControlMode, delay: u8) -> Result<()>

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

pub fn get_cards(&mut self) -> Result<i32>

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

pub fn get_card(&mut self, card_number: u32) -> Result<Card>

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

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

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

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

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

pub fn record_special_events(&mut self, enabled: bool) -> Result<()>

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

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

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

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

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

pub fn clear_task_list(&mut self) -> 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_address(
&mut self,
address: String,
subnet: String,
gateway: String
) -> Result<()>

pub fn set_door_control(
&mut self,
door: u8,
mode: DoorControlMode,
delay: u8
) -> 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>,