Skip to main content

Host

Struct Host 

Source
pub struct Host { /* private fields */ }
Expand description

Configuration and callbacks for a window’s host.

§Safety

This type and its methods are always safe to use.

It also brings the additional safety guarantee that all handlers given to this type will be destroyed alongside with the window.

This guarantees callbacks cannot be fired after the Window is dropped. (or after this Host object is dropped, if it never made it to a Window::create_with_host call).

Implementations§

Source§

impl Host

Source

pub fn new() -> Self

Creates a new, empty host with no callbacks.

Calling Window::create_with_host with this is equivalent to just calling Window::create.

Source

pub fn with_main_thread(self, main_thread: impl HostMainThreadCaller) -> Self

Sets the HostMainThreadCaller handler to be used.

If another callback handler was already set, it is replaced.

§Platform Compatibility notes

This is only useful on X11. On Window and macOS, this is a no-op.

Source

pub fn with_callbacks(self, callbacks: impl HostCallbacks) -> Self

Sets the HostCallbacks handler to be used.

If another callback handler was already set, it is replaced.

Trait Implementations§

Source§

impl Default for Host

Source§

fn default() -> Self

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

Auto Trait Implementations§

§

impl !Freeze for Host

§

impl !RefUnwindSafe for Host

§

impl !Send for Host

§

impl !Sync for Host

§

impl !UnwindSafe for Host

§

impl Unpin for Host

§

impl UnsafeUnpin for Host

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more