Trait rust_dmx::DmxPort

pub trait DmxPort: Display + Serialize + Deserialize {
    fn available_ports() -> Result<Vec<Box<dyn DmxPort>>, Error>
    where
        Self: Sized;
    fn open(&mut self) -> Result<(), Error>;
    fn close(&mut self);
    fn write(&mut self, frame: &[u8]) -> Result<(), Error>;
}

Trait for the general notion of a DMX port. This enables creation of an “offline” port to slot into place if an API requires an output.

Required methods

fn available_ports() -> Result<Vec<Box<dyn DmxPort>>, Error> where
    Self: Sized, 

Return the available ports. The ports will need to be opened before use.

fn open(&mut self) -> Result<(), Error>

Open the port for writing. Implementations should no-op if this is called twice rather than returning an error. Primarily used to re-open a port that has be deserialized.

fn close(&mut self)

Close the port.

fn write(&mut self, frame: &[u8]) -> Result<(), Error>

Write a DMX frame out to the port. If the frame is smaller than the minimum universe size, it will be padded with zeros. If the frame is larger than the maximum universe size, the values beyond the max size will be ignored.

Loading content...

Trait Implementations

impl<'typetag> Serialize for dyn DmxPort + 'typetag

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'typetag> Serialize for dyn DmxPort + Send + 'typetag

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'typetag> Serialize for dyn DmxPort + Sync + 'typetag

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'typetag> Serialize for dyn DmxPort + Send + Sync + 'typetag

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl Strictest for dyn DmxPort

type Object = dyn DmxPort

Implementors

impl DmxPort for EnttecDmxPort

fn available_ports() -> Result<Vec<Box<dyn DmxPort>>, Error>

Return the available enttec ports connected to this system. TODO: provide a mechanism to specialize this implementation depending on platform.

fn open(&mut self) -> Result<(), Error>

Open the port.

fn close(&mut self)

fn write(&mut self, frame: &[u8]) -> Result<(), Error>

impl DmxPort for OfflineDmxPort

fn available_ports() -> Result<Vec<Box<dyn DmxPort>>, Error>

fn open(&mut self) -> Result<(), Error>

fn close(&mut self)

fn write(&mut self, _: &[u8]) -> Result<(), Error>

Loading content...