[][src]Module bbqueue::cm_mutex

👎 Deprecated:

There are no longer separate 'atomic' and 'cm_mutex' modules. You can just use the types at the crate root.

There are no longer separate atomic and cm_mutex modules. You can just use the types at the crate root.

Modules

consts

Type aliases for many constants.

Structs

BBBuffer

A backing structure for a BBQueue. Can be used to create either a BBQueue or a split Producer/Consumer pair

ConstBBBuffer

const-fn version BBBuffer

Consumer

Consumer is the primary interface for reading data from a BBBuffer.

GrantR

A structure representing a contiguous region of memory that may be read from, and potentially "released" (or cleared) from the queue

GrantW

A structure representing a contiguous region of memory that may be written to, and potentially "committed" to the queue.

Producer

Producer is the primary interface for pushing data into a BBBuffer. There are various methods for obtaining a grant to write to the buffer, with different potential tradeoffs. As all grants are required to be a contiguous range of data, different strategies are sometimes useful when making the decision between maximizing usage of the buffer, and ensuring a given grant is successful.

SplitGrantR

A structure representing up to two contiguous regions of memory that may be read from, and potentially "released" (or cleared) from the queue

Type Definitions

AutoCommitGrantWDeprecated

You can now use the to_commit method on grants to have them auto-commit

AutoReleaseGrantRDeprecated

You can now use the to_release method on grants to have them auto-release