Library guide · API index and notation
This page is generated from the bundled library in this checkout. Signatures and adjacent source comments are reproduced below; the linked guide explains usage, storage, failures, and platform support.
import "std/signal/posix"
This is a provider or implementation package. Start with the linked guide’s application API; native declarations depend on the selected target.
Names used in signatures
Unqualified names denote this package’s types (including other source files in the same package), language built-ins, or generic parameters such as T. Qualified names use the import aliases below. These aliases belong to the library source; import a dependency yourself to use its alias in your program.
| Alias | Package | Source file |
|---|---|---|
error |
std/platform/error |
posix.dodo |
native |
std/platform/native |
posix.dodo |
net |
std/net |
posix.dodo |
poll |
std/net/native |
posix.dodo |
ptr |
core/ptr |
posix.dodo |
Channel
Struct · Source
Handlers are process-wide, so one channel is open at a time. Tags and mask bits are std/signal Signal ordinals.
pub struct Channel {
// Private implementation fields omitted.
}
Channel.open
Function · Source
pub fn open(mask: u32) -> Channel!error.Error
Channel.register
Function · Source
pub fn register(&self, set: &mut poll.PollSet) -> usize!net.Error
Channel.next
Function · Source
pub fn next(&mut self) -> Option<u32>
Channel.wait
Function · Source
True when the channel became readable; may return early on POSIX when a signal interrupts the wait.
pub fn wait(&mut self, milliseconds: u32) -> bool!error.Error
Channel.shutdown_requested
Function · Source
pub fn shutdown_requested(&self) -> bool
Channel.close
Function · Source
pub fn close(&mut self) -> void!error.Error