# [−][src]Struct mio::unix::EventedFd

    pub struct EventedFd<'a>(pub &'a RawFd);

Adapter for `RawFd` providing an `Evented` implementation.

`EventedFd` enables registering any type with an FD with `Poll`.

While only implementations for TCP and UDP are provided, Mio supports registering any FD that can be registered with the underlying OS selector. `EventedFd` provides the necessary bridge.

Note that `EventedFd` takes a `&RawFd`. This is because `EventedFd` does not take ownership of the FD. Specifically, it will not manage any lifecycle related operations, such as closing the FD on drop. It is expected that the `EventedFd` is constructed right before a call to `Poll::register`. See the examples for more detail.

# Examples

Basic usage

    use mio::{Ready, Poll, PollOpt, Token};
    use mio::unix::EventedFd;

    use std::os::unix::io::AsRawFd;
    use std::net::TcpListener;

    // Bind a std listener
    let listener = TcpListener::bind("127.0.0.1:0")?;

    let poll = Poll::new()?;

    // Register the listener
    poll.register(&EventedFd(&listener.as_raw_fd()),
                 Token(0), Ready::readable(), PollOpt::edge())?;

Implementing `Evented` for a custom type backed by a `RawFd`.

    use mio::{Ready, Poll, PollOpt, Token};
    use mio::event::Evented;
    use mio::unix::EventedFd;

    use std::os::unix::io::RawFd;
    use std::io;

    pub struct MyIo {
        fd: RawFd,
    }

    impl Evented for MyIo {
        fn register(&self, poll: &Poll, token: Token, interest: Ready, opts: PollOpt)
            -> io::Result<()>
        {
            EventedFd(&self.fd).register(poll, token, interest, opts)
        }

        fn reregister(&self, poll: &Poll, token: Token, interest: Ready, opts: PollOpt)
            -> io::Result<()>
        {
            EventedFd(&self.fd).reregister(poll, token, interest, opts)
        }

        fn deregister(&self, poll: &Poll) -> io::Result<()> {
            EventedFd(&self.fd).deregister(poll)
        }
    }

## Trait Implementations

### `impl<'a> Evented for EventedFd<'a>`[src]

#### `fn register(
&self,
poll: &Poll,
token: Token,
interest: Ready,
opts: PollOpt
) -> Result<()>`[src]

Register `self` with the given `Poll` instance. Read more

#### `fn reregister(
&self,
poll: &Poll,
token: Token,
interest: Ready,
opts: PollOpt
) -> Result<()>`[src]

Re-register `self` with the given `Poll` instance. Read more

#### `fn deregister(&self, poll: &Poll) -> Result<()>`[src]

Deregister `self` from the given `Poll` instance Read more

### `impl<'a> Debug for EventedFd<'a>`[src]

#### `fn fmt(&self, f: &mut Formatter) -> Result`[src]

Formats the value using the given formatter. Read more

## Auto Trait Implementations

### `impl<'a> Send for EventedFd<'a>`

### `impl<'a> Unpin for EventedFd<'a>`

### `impl<'a> Sync for EventedFd<'a>`

### `impl<'a> UnwindSafe for EventedFd<'a>`

### `impl<'a> RefUnwindSafe for EventedFd<'a>`

## Blanket Implementations

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `fn into(self) -> U`[src]

Performs the conversion.

### `impl<T> From<T> for T`[src]

#### `fn from(t: T) -> T`[src]

Performs the conversion.

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

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

The type returned in the event of a conversion error.

#### `fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]

Performs the conversion.

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

####
ⓘImportant traits for &'_ mut W

### Important traits for &'_ mut W

`impl<'_, W> Write for &'_ mut W where
W: Write + ?Sized, impl<'_, R> Read for &'_ mut R where
R: Read + ?Sized,`
`fn borrow_mut(&mut self) -> &mut T`[src]

Mutably borrows from an owned value. Read more

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

####
ⓘImportant traits for &'_ mut W

### Important traits for &'_ mut W

`impl<'_, W> Write for &'_ mut W where
W: Write + ?Sized, impl<'_, R> Read for &'_ mut R where
R: Read + ?Sized,`
`fn borrow(&self) -> &T`[src]

Immutably borrows from an owned value. Read more

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `fn type_id(&self) -> TypeId`[src]

Gets the `TypeId` of `self`. Read more

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g., `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g., `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g., `str,u8` or `String,struct:Vec,test`)