# actix_web::ws::Frame - Rust
API documentation for the Rust `Frame` struct in crate `actix_web`.
Keywords: rust, rustlang, rust-lang, Frame

# Struct actix_web::ws::Frame [−] [src]

    pub struct Frame { /* fields omitted */ }

A struct representing a `WebSocket` frame.

## Methods

###

`impl Frame`

[src]

####

`pub fn unpack(self) -> (bool, OpCode, Binary)`

[src]

Destruct frame

####

`pub fn close(reason: Option<CloseReason>, genmask: bool) -> FramedMessage`

[src]

Create a new Close control frame.

####

`pub fn parse<S>( pl: &mut PayloadBuffer<S>, server: bool, max_size: usize ) -> Poll<Option<Frame>, ProtocolError> where S: Stream<Item = Bytes, Error = PayloadError>,`

[src]

Parse the input stream into a frame.

####

`pub fn parse_close_payload(payload: &Binary) -> Option<CloseReason>`

[src]

Parse the payload of a close frame.

####

`pub fn message<B: Into<Binary>>( data: B, code: OpCode, finished: bool, genmask: bool ) -> FramedMessage`

[src]

Generate binary representation

## Trait Implementations

###

`impl Debug for Frame`

[src]

####

`fn fmt(&self, f: &mut Formatter) -> Result`

[src]

Formats the value using the given formatter. Read more

###

`impl Default for Frame`

[src]

####

`fn default() -> Frame`

[src]

Returns the "default value" for a type. Read more

###

`impl Display for Frame`

[src]

####

`fn fmt(&self, f: &mut Formatter) -> Result`

[src]

Formats the value using the given formatter. Read more

## Auto Trait Implementations

###

`impl Send for Frame`

###

`impl Sync for Frame`

# 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`)