Struct aya::programs::lirc_mode2::LircMode2

pub struct LircMode2 { /* private fields */ }

A program used to decode IR into key events for a lirc device.

LircMode2 programs can be used to inspect infrared pulses, spaces, and timeouts received by a lirc IR receiver.

Minimum kernel version

The minimum kernel version required to use this feature is 4.18.

Examples

use std::fs::File;
use std::convert::TryInto;
use aya::programs::LircMode2;

let file = File::open("/dev/lirc0")?;
let mut bpf = aya::Bpf::load_file("imon_rsc.o")?;
let decoder: &mut LircMode2 = bpf.program_mut("imon_rsc").unwrap().try_into().unwrap();
decoder.load()?;
decoder.attach(file)?;

Implementations

impl LircMode2

pub fn load(&mut self) -> Result<(), ProgramError>

Loads the program inside the kernel.

pub fn attach<T: AsRawFd>(
    &mut self,
    lircdev: T
) -> Result<LircLinkId, ProgramError>

Attaches the program to the given lirc device.

The returned value can be used to detach, see LircMode2::detach.

pub fn detach(&mut self, link_id: LircLinkId) -> Result<(), ProgramError>

Detaches the program.

See LircMode2::attach.

pub fn take_link(
    &mut self,
    link_id: LircLinkId
) -> Result<OwnedLink<LircLink>, ProgramError>

Takes ownership of the link referenced by the provided link_id.

The link will be detached on Drop and the caller is now responsible for managing its lifetime.

pub fn query<T: AsRawFd>(target_fd: T) -> Result<Vec<LircLink>, ProgramError>

Queries the lirc device for attached programs.

impl LircMode2

pub fn unload(&mut self) -> Result<(), ProgramError>

Unloads the program from the kernel.

Links will be detached before unloading the program. Note that owned links obtained using take_link() will not be detached.

Trait Implementations

impl Debug for LircMode2

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

Formats the value using the given formatter.

impl ProgramFd for LircMode2

fn fd(&self) -> Option<RawFd>

Returns the RawFd of the program if it has been loaded, or None

impl ProgramFd for &mut LircMode2

fn fd(&self) -> Option<RawFd>

Returns the RawFd of the program if it has been loaded, or None

impl<'a> TryFrom<&'a Program> for &'a LircMode2

type Error = ProgramError

The type returned in the event of a conversion error.

fn try_from(program: &'a Program) -> Result<&'a LircMode2, ProgramError>

Performs the conversion.

impl<'a> TryFrom<&'a mut Program> for &'a mut LircMode2

type Error = ProgramError

The type returned in the event of a conversion error.

fn try_from(program: &'a mut Program) -> Result<&'a mut LircMode2, ProgramError>

Performs the conversion.