firewire_dice_protocols::tcat::global_section

Struct GlobalParameters

pub struct GlobalParameters {
    pub owner: u64,
    pub latest_notification: u32,
    pub nickname: String,
    pub clock_config: ClockConfig,
    pub enable: bool,
    pub clock_status: ClockStatus,
    pub external_source_states: ExternalSourceStates,
    pub current_rate: u32,
    pub version: u32,
    pub avail_rates: Vec<ClockRate>,
    pub avail_sources: Vec<ClockSource>,
    pub clock_source_labels: Vec<(ClockSource, String)>,
}

Expand description

Parameters in global section.

Fields§

§owner: u64

The address offset of owner node to which Any notification is sent.

§latest_notification: u32

The latest notification sent to the owner node.

§nickname: String

Nickname of the node. When the same units are in the same bus, it is available to distinguish them.

§clock_config: ClockConfig

The configuration of media clock and sampling clock.

§enable: bool

Whether to enable packet streaming or not.

§clock_status: ClockStatus

The status of sampling clock.

§external_source_states: ExternalSourceStates

The states of external clock sources. Any change is notified by NOTIFY_EXT_STATUS.

§current_rate: u32

Detected rate of sampling clock in Hz.

§version: u32

The version of protocol.

§avail_rates: Vec<ClockRate>

The list of available rates for media clock.

§avail_sources: Vec<ClockSource>

The list of available sources for sampling clock.

§clock_source_labels: Vec<(ClockSource, String)>

The list of external signal names for source of sampling clock.

Trait Implementations§

impl Clone for GlobalParameters

fn clone(&self) -> GlobalParameters

Returns a duplicate of the value. Read more

1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl Debug for GlobalParameters

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

Formats the value using the given formatter. Read more

impl Default for GlobalParameters

fn default() -> GlobalParameters

Returns the “default value” for a type. Read more

impl PartialEq for GlobalParameters

fn eq(&self, other: &GlobalParameters) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for GlobalParameters

impl StructuralPartialEq for GlobalParameters

Auto Trait Implementations§

impl Freeze for GlobalParameters

impl RefUnwindSafe for GlobalParameters

impl Send for GlobalParameters

impl Sync for GlobalParameters

impl Unpin for GlobalParameters

impl UnwindSafe for GlobalParameters

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<O> TcatFluctuatedSectionOperation<GlobalParameters> for O
where O: TcatSectionOperation<GlobalParameters>,

const FLUCTUATED_OFFSETS: &'static [usize] = const FLUCTUATED_OFFSETS: &'static [usize] = &[88];

The set of address offsets in which any value is changed apart from software operation; e.g. hardware metering.

fn partial_cache( req: &FwReq, node: &FwNode, section: &Section, params: &mut T, timeout_ms: u32, ) -> Result<(), Error>

Cache part of section for fluctuated values, then deserialize for parameters.

impl<O> TcatMutableSectionOperation<GlobalParameters> for O
where O: TcatOperation + TcatSectionSerdes<GlobalParameters>,

fn whole_update( req: &FwReq, node: &FwNode, section: &Section, params: &T, timeout_ms: u32, ) -> Result<(), Error>

Update whole section by the parameters.

fn partial_update( req: &FwReq, node: &FwNode, section: &Section, params: &T, prev: &mut T, timeout_ms: u32, ) -> Result<(), Error>

Update part of section for any change at the parameters.

impl<O> TcatNotifiedSectionOperation<GlobalParameters> for O
where O: TcatSectionOperation<GlobalParameters>,

const NOTIFY_FLAG: u32 = 112u32

Flag in message notified for any change in section.

fn notified(_: &T, msg: u32) -> bool

Check message to be notified or not.

impl<O> TcatSectionOperation<GlobalParameters> for O
where O: TcatOperation + TcatSectionSerdes<GlobalParameters>,

fn whole_cache( req: &FwReq, node: &FwNode, section: &Section, params: &mut T, timeout_ms: u32, ) -> Result<(), Error>

Cache whole section and deserialize for parameters.

impl<O> TcatSectionSerdes<GlobalParameters> for O
where O: TcatOperation + TcatGlobalSectionSpecification,

const MIN_SIZE: usize = 96usize

Minimum size of section for parameters.

const ERROR_TYPE: GeneralProtocolError = const ERROR_TYPE: GeneralProtocolError = GeneralProtocolError::Global;

The type of error.

fn serialize(params: &GlobalParameters, raw: &mut [u8]) -> Result<(), String>

Serialize parameters for section.

fn deserialize(params: &mut GlobalParameters, raw: &[u8]) -> Result<(), String>

Deserialize section for parameters.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

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

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.