Module dev 

The client side: DevProxy, the handle to a device, and what it reads and writes.

Structs

All

A marker struct for specifying names for various functions that are using ToNames to specify to select all names available on the device.

AttrArchiveEventConfig

The criteria of the archive event: the same two changes as the change event, and the longest an archiver may go without an event when the value does not move.

AttrChangeEventConfig

The criteria of the change event: how much the value has to move for the server to send one, absolutely or relatively, either of which may be left out.

AttrConfig

Represent the current configuration of an attribute.

AttrDeltaConfig

The alarm on the read value drifting away from the written one.

AttrInfo

An extension to AttrConfig with static information about the attribute.

AttrPeriodicEventConfig

AttrRangeConfig

The two bounds of one of the ranges of an attribute, either of which is absent for a range that is open on that side, which is also how an attribute says it has no such range at all.

AttrRead

Represent the reading for a single attribute.

AttrReady

An attribute announced as ready to be read, which is what a data ready event carries: nothing of the reading itself, which is the subscriber’s to make, but the data kind of the attribute and a counter the device gives with every announcement, telling which of its readings is the one made ready.

CommandInfo

Static information about a command.

DevChannel

The events of a subscription to a device, which unsubscribes when it is dropped: it is a Stream for an asynchronous caller, and Self::wait blocks for a synchronous one.

DevInfo

Static information about a device: what it is and where it runs.

DevProxy

A device proxy is an object that allows querying a remote device.

Named

Something along with the name it is of, the name sharing the octets it was decoded out of like any other string.

Recorded

Something along with the time it was recorded at, which is what a history gives one of per entry, see DevProxy::command_history: the result of what was recorded then, which is not the one of the request asking for the history.

Enums

AttrMemorized

What a memorized attribute does, when its device is initialized, with the value it remembers.

AttrMode

Attribute read/write mode.

AttrNumber

A limit of an attribute: one of the bounds of one of its ranges, or the delta of its read-different-from-set alarm.

AttrQuality

Quality factor of the attribute.

AttrValueEvent

Kind of event for a device attribute.

DevSource

Source when querying an attribute.

DevState

All possible device states.

DisplayLevel

Traits

ReadAttrSpec

A trait for attribute specifiers, which allows a great flexibility in how DevProxy::read_attr works.

ToNames

Supporting trait for being generic over the different types that can be interpreted as names, either single or many names.

ToNamesNotAll

Same as ToNames but this marker ensures that no None will be returned by to_names.

ToNamesSpec

Generic specification type used for command and attribute info, as there is no special processing to do on the resulted value! This is an extension to the ToNames, because this spec’s output only depends on the actual type of the names we give.

WriteAttrSpec

The values to write to one or many attributes, see DevProxy::write_attr.

Type Aliases

NamedResult

What a request answering for several names gives one of per name, see Named.

RecordedResult

What a history gives one of per entry, see Recorded.