Crate hinoko

source ·
Expand description

hinoko crate

Rust API bindings and wrappers for hinoko library to operate Linux FireWire character device for isochronous packets and resources in IEEE 1394 bus.

The hinoko library version 0.8.0 is the minimum supported version for underlying library.

The hinoko crate is automatically generated by gir tool provided by gtk-rs project. Hinoko-0.0 file from hinoko library is used for the generation. But some functions are implemented manually.

Usage

Add the following line to your Cargo.toml file:

[dependencies]
hinoko = "0.2.0"

The API documentation is available in https://docs.rs/hinoko/.

License

The hinoko crate is released under MIT license.

Dependency

The hinoko crate depends on API crates provided by gtk-rs project for type/object system, event loop, and dispacher.

Features

  • dox

    • Suppress probing hinoko library. It’s automatically enabled when generating documentation in docs.rs.

Repository

The hinoko-sys crate is maintained by Takashi Sakamoto. The remote repository is located in https://github.com/takaswie/hinoko-rs/.

Support

If finding issue, please file it in https://github.com/takaswie/hinoko-rs/.

Sample programs

Some programs are available under examples directory.

  • fw-iso-resource

    • demonstration to allocate and deallocate isochronous resources
  • fw-iso-rx-single

    • demonstration to receive isochronous packets at single channel
  • fw-iso-rx-multiple

    • demonstration to receive isochronous packets at multiple channels
  • fw-iso-tx

    • demonstration to transmit isochronous packets at single channel

Re-exports

pub use ffi;

Modules

For convenience to provide auto-generated/manual traits, and their blanket implementations.
For subclass implementations derived from provided class.

Structs

A boxed object to express data of cycle timer.
An basic interface to operate isochronous context on 1394 OHCI controller.
A set of tag field of isochronous packet on IEEE 1394 bus.
An object to receive isochronous packet for several channels.
An object to receive isochronous packet for single channel.
An object to transmit isochronous packet for single channel.
An interface object to listen events of isochronous resource allocation and deallocation.
An object to maintain allocated isochronous resource.
An object to initiate requests and listen events of isochronous resource allocation/deallocation

Enums

A set of error code for FwIsoCtx.
A set of mode for isochronous context of Linux FireWire subsystem.
A set of error code for FwIsoResource.
A set of speed for isochronous context on IEEE 1394 bus.