Struct Port
pub struct Port(/* private fields */);
Expand description
An object representing a Zircon port.
As essentially a subtype of Handle
, it can be freely interconverted.
Implementations§
§impl Port
impl Port
pub fn create() -> Port
pub fn create() -> Port
Create an IO port, allowing IO packets to be read and enqueued.
Wraps the zx_port_create syscall.
§Panics
If the kernel reports no memory available to create a port or the process’ job policy denies port creation.
pub fn create_with_opts(opts: PortOptions) -> Port
pub fn queue(&self, packet: &Packet) -> Result<(), Status>
pub fn queue(&self, packet: &Packet) -> Result<(), Status>
Attempt to queue a user packet to the IO port.
Wraps the zx_port_queue syscall.
pub fn wait(
&self,
deadline: Instant<MonotonicTimeline>,
) -> Result<Packet, Status>
pub fn wait( &self, deadline: Instant<MonotonicTimeline>, ) -> Result<Packet, Status>
Wait for a packet to arrive on a (V2) port.
Wraps the zx_port_wait syscall.
Trait Implementations§
§impl AsHandleRef for Port
impl AsHandleRef for Port
§fn as_handle_ref(&self) -> Unowned<'_, Handle>
fn as_handle_ref(&self) -> Unowned<'_, Handle>
Get a reference to the handle. One important use of such a reference is
for
object_wait_many
.§fn raw_handle(&self) -> u32
fn raw_handle(&self) -> u32
Interpret the reference as a raw handle (an integer type). Two distinct
handles will have different raw values (so it can perhaps be used as a
key in a data structure).
§fn signal_handle(
&self,
clear_mask: Signals,
set_mask: Signals,
) -> Result<(), Status>
fn signal_handle( &self, clear_mask: Signals, set_mask: Signals, ) -> Result<(), Status>
Set and clear userspace-accessible signal bits on an object. Wraps the
zx_object_signal
syscall.
§fn wait_handle(
&self,
signals: Signals,
deadline: Instant<MonotonicTimeline>,
) -> WaitResult
fn wait_handle( &self, signals: Signals, deadline: Instant<MonotonicTimeline>, ) -> WaitResult
Waits on a handle. Wraps the
zx_object_wait_one
syscall.
§fn wait_async_handle(
&self,
port: &Port,
key: u64,
signals: Signals,
options: WaitAsyncOpts,
) -> Result<(), Status>
fn wait_async_handle( &self, port: &Port, key: u64, signals: Signals, options: WaitAsyncOpts, ) -> Result<(), Status>
Causes packet delivery on the given port when the object changes state and matches signals.
zx_object_wait_async
syscall.
§fn get_name(&self) -> Result<Name, Status>
fn get_name(&self) -> Result<Name, Status>
Get the Property::NAME property for this object. Read more
§fn set_name(&self, name: &Name) -> Result<(), Status>
fn set_name(&self, name: &Name) -> Result<(), Status>
Set the Property::NAME property for this object. Read more
§fn basic_info(&self) -> Result<HandleBasicInfo, Status>
fn basic_info(&self) -> Result<HandleBasicInfo, Status>
Wraps the
zx_object_get_info
syscall for the ZX_INFO_HANDLE_BASIC topic.
§fn count_info(&self) -> Result<HandleCountInfo, Status>
fn count_info(&self) -> Result<HandleCountInfo, Status>
Wraps the
zx_object_get_info
syscall for the ZX_INFO_HANDLE_COUNT topic.
Source§impl CompatFrom<Port> for Port
impl CompatFrom<Port> for Port
Source§fn compat_from(value: Port) -> Port
fn compat_from(value: Port) -> Port
Converts
value
into a value of this type.Source§impl Encodable for Port
impl Encodable for Port
Source§const COPY_OPTIMIZATION: CopyOptimization<Self, Self::Encoded> = _
const COPY_OPTIMIZATION: CopyOptimization<Self, Self::Encoded> = _
Whether the conversion from
Self
to Self::Encoded
is equivalent to copying the raw bytes
of Self
. Read moreSource§impl EncodableOption for Port
impl EncodableOption for Port
Source§type EncodedOption = WireOptionalPort
type EncodedOption = WireOptionalPort
The wire type for the optional value.
Source§impl<E> EncodeOption<E> for Portwhere
E: HandleEncoder + ?Sized,
impl<E> EncodeOption<E> for Portwhere
E: HandleEncoder + ?Sized,
Source§fn encode_option(
this: Option<Port>,
encoder: &mut E,
out: &mut MaybeUninit<<Port as EncodableOption>::EncodedOption>,
) -> Result<(), EncodeError>
fn encode_option( this: Option<Port>, encoder: &mut E, out: &mut MaybeUninit<<Port as EncodableOption>::EncodedOption>, ) -> Result<(), EncodeError>
Encodes this optional value into an encoder and output.
Source§impl FromWire<WirePort> for Port
impl FromWire<WirePort> for Port
Source§const COPY_OPTIMIZATION: CopyOptimization<W, Self> = _
const COPY_OPTIMIZATION: CopyOptimization<W, Self> = _
Source§impl FromWireOption<WireOptionalPort> for Port
impl FromWireOption<WireOptionalPort> for Port
Source§fn from_wire_option(wire: WireOptionalPort) -> Option<Port>
fn from_wire_option(wire: WireOptionalPort) -> Option<Port>
Converts the given
wire
to an option of this type.§impl HandleBased for Port
impl HandleBased for Port
§fn duplicate_handle(&self, rights: Rights) -> Result<Self, Status>
fn duplicate_handle(&self, rights: Rights) -> Result<Self, Status>
Duplicate a handle, possibly reducing the rights available. Wraps the
zx_handle_duplicate
syscall.
§fn replace_handle(self, rights: Rights) -> Result<Self, Status>
fn replace_handle(self, rights: Rights) -> Result<Self, Status>
Create a replacement for a handle, possibly reducing the rights available. This invalidates
the original handle. Wraps the
zx_handle_replace
syscall.
§fn into_handle(self) -> Handle
fn into_handle(self) -> Handle
Converts the value into its inner handle. Read more
§fn from_handle(handle: Handle) -> Self
fn from_handle(handle: Handle) -> Self
Creates an instance of this type from a handle. Read more
§fn into_handle_based<H>(self) -> Hwhere
H: HandleBased,
fn into_handle_based<H>(self) -> Hwhere
H: HandleBased,
Creates an instance of another handle-based type from this value’s inner handle.
§fn from_handle_based<H>(h: H) -> Selfwhere
H: HandleBased,
fn from_handle_based<H>(h: H) -> Selfwhere
H: HandleBased,
Creates an instance of this type from the inner handle of another
handle-based type.
fn is_invalid_handle(&self) -> bool
§impl Ord for Port
impl Ord for Port
§impl PartialOrd for Port
impl PartialOrd for Port
impl Eq for Port
impl StructuralPartialEq for Port
Auto Trait Implementations§
impl Freeze for Port
impl RefUnwindSafe for Port
impl Send for Port
impl Sync for Port
impl Unpin for Port
impl UnwindSafe for Port
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<T> EncodableAsHandle for Twhere
T: HandleBased,
impl<T> EncodableAsHandle for Twhere
T: HandleBased,
§impl<T, D> Encode<Ambiguous1, D> for Twhere
D: ResourceDialect,
impl<T, D> Encode<Ambiguous1, D> for Twhere
D: ResourceDialect,
§impl<T, D> Encode<Ambiguous2, D> for Twhere
D: ResourceDialect,
impl<T, D> Encode<Ambiguous2, D> for Twhere
D: ResourceDialect,
Source§impl<T, W> FromWireOption<WireBox<'_, W>> for Twhere
T: FromWire<W>,
impl<T, W> FromWireOption<WireBox<'_, W>> for Twhere
T: FromWire<W>,
Source§fn from_wire_option(wire: WireBox<'_, W>) -> Option<T>
fn from_wire_option(wire: WireBox<'_, W>) -> Option<T>
Converts the given
wire
to an option of this type.