[][src]Struct jack::PortFlags

pub struct PortFlags { /* fields omitted */ }

Flags for specifying port options.

Implementations

impl PortFlags[src]

pub const IS_INPUT: PortFlags[src]

The port can receive data.

pub const IS_OUTPUT: PortFlags[src]

Data can be read from the port.

pub const IS_PHYSICAL: PortFlags[src]

Port corresponds to some kind of physical I/O connector.

pub const CAN_MONITOR: PortFlags[src]

A call to jack_port_request_monitor() makes sense.

TODO implement

Precisely what this means it dependent on the client. A typical result of it being called with true as the second argument is that data that would be available from an output port (with IS_PHYSICAL set) is sent to a physical output connector as well, so that it can be heard/seen/whatever.

pub const IS_TERMINAL: PortFlags[src]

For an input port, the data received by the port will not be passed on or made available at any other port. For output, the data available at the port does not originate from any other port. Audio synthesizers, I/O hardware interface clients, HDR systems are examples of clients that would set this flag for their ports.

pub const fn empty() -> PortFlags[src]

Returns an empty set of flags

pub const fn all() -> PortFlags[src]

Returns the set containing all flags.

pub const fn bits(&self) -> Enum_JackPortFlags[src]

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: Enum_JackPortFlags) -> Option<PortFlags>[src]

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: Enum_JackPortFlags) -> PortFlags[src]

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: Enum_JackPortFlags) -> PortFlags[src]

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool[src]

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool[src]

Returns true if all flags are currently set.

pub const fn intersects(&self, other: PortFlags) -> bool[src]

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: PortFlags) -> bool[src]

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: PortFlags)[src]

Inserts the specified flags in-place.

pub fn remove(&mut self, other: PortFlags)[src]

Removes the specified flags in-place.

pub fn toggle(&mut self, other: PortFlags)[src]

Toggles the specified flags in-place.

pub fn set(&mut self, other: PortFlags, value: bool)[src]

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl Binary for PortFlags[src]

impl BitAnd<PortFlags> for PortFlags[src]

type Output = PortFlags

The resulting type after applying the & operator.

fn bitand(self, other: PortFlags) -> PortFlags[src]

Returns the intersection between the two sets of flags.

impl BitAndAssign<PortFlags> for PortFlags[src]

fn bitand_assign(&mut self, other: PortFlags)[src]

Disables all flags disabled in the set.

impl BitOr<PortFlags> for PortFlags[src]

type Output = PortFlags

The resulting type after applying the | operator.

fn bitor(self, other: PortFlags) -> PortFlags[src]

Returns the union of the two sets of flags.

impl BitOrAssign<PortFlags> for PortFlags[src]

fn bitor_assign(&mut self, other: PortFlags)[src]

Adds the set of flags.

impl BitXor<PortFlags> for PortFlags[src]

type Output = PortFlags

The resulting type after applying the ^ operator.

fn bitxor(self, other: PortFlags) -> PortFlags[src]

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign<PortFlags> for PortFlags[src]

fn bitxor_assign(&mut self, other: PortFlags)[src]

Toggles the set of flags.

impl Clone for PortFlags[src]

impl Copy for PortFlags[src]

impl Debug for PortFlags[src]

impl Eq for PortFlags[src]

impl Extend<PortFlags> for PortFlags[src]

impl FromIterator<PortFlags> for PortFlags[src]

impl Hash for PortFlags[src]

impl LowerHex for PortFlags[src]

impl Not for PortFlags[src]

type Output = PortFlags

The resulting type after applying the ! operator.

fn not(self) -> PortFlags[src]

Returns the complement of this set of flags.

impl Octal for PortFlags[src]

impl Ord for PortFlags[src]

impl PartialEq<PortFlags> for PortFlags[src]

impl PartialOrd<PortFlags> for PortFlags[src]

impl StructuralEq for PortFlags[src]

impl StructuralPartialEq for PortFlags[src]

impl Sub<PortFlags> for PortFlags[src]

type Output = PortFlags

The resulting type after applying the - operator.

fn sub(self, other: PortFlags) -> PortFlags[src]

Returns the set difference of the two sets of flags.

impl SubAssign<PortFlags> for PortFlags[src]

fn sub_assign(&mut self, other: PortFlags)[src]

Disables all flags enabled in the set.

impl UpperHex for PortFlags[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.