Struct ws::Response [−][src]
pub struct Response { /* fields omitted */ }The handshake response.
Methods
impl Response[src]
impl Responsepub fn new<R>(status: u16, reason: R, body: Vec<u8>) -> Response where
R: Into<String>, [src]
pub fn new<R>(status: u16, reason: R, body: Vec<u8>) -> Response where
R: Into<String>, Construct a generic HTTP response with a body.
pub fn body(&self) -> &[u8][src]
pub fn body(&self) -> &[u8]Get the response body.
pub fn header_mut(&mut self, header: &str) -> Option<&mut Vec<u8>>[src]
pub fn header_mut(&mut self, header: &str) -> Option<&mut Vec<u8>>Edit the value of the first instance of an HTTP header.
pub fn headers(&self) -> &Vec<(String, Vec<u8>)>[src]
pub fn headers(&self) -> &Vec<(String, Vec<u8>)>Access the request headers.
pub fn headers_mut(&mut self) -> &mut Vec<(String, Vec<u8>)>[src]
pub fn headers_mut(&mut self) -> &mut Vec<(String, Vec<u8>)>Edit the request headers.
pub fn status(&self) -> u16[src]
pub fn status(&self) -> u16Get the HTTP status code.
pub fn set_status(&mut self, status: u16)[src]
pub fn set_status(&mut self, status: u16)Set the HTTP status code.
pub fn reason(&self) -> &str[src]
pub fn reason(&self) -> &strGet the HTTP status reason.
pub fn set_reason<R>(&mut self, reason: R) where
R: Into<String>, [src]
pub fn set_reason<R>(&mut self, reason: R) where
R: Into<String>, Set the HTTP status reason.
pub fn key(&self) -> Result<&Vec<u8>>[src]
pub fn key(&self) -> Result<&Vec<u8>>Get the hashed WebSocket key.
pub fn protocol(&self) -> Result<Option<&str>>[src]
pub fn protocol(&self) -> Result<Option<&str>>Get the protocol that the server has decided to use.
pub fn set_protocol(&mut self, protocol: &str)[src]
pub fn set_protocol(&mut self, protocol: &str)Set the protocol that the server has decided to use.
pub fn extensions(&self) -> Result<Vec<&str>>[src]
pub fn extensions(&self) -> Result<Vec<&str>>Get the extensions that the server has decided to use. If these are unacceptable, it is appropriate to send an Extension close code.
pub fn add_extension(&mut self, ext: &str)[src]
pub fn add_extension(&mut self, ext: &str)Add an accepted extension to this response. This may result in duplicate extensions listed.
pub fn remove_extension(&mut self, ext: &str)[src]
pub fn remove_extension(&mut self, ext: &str)Remove an accepted extension from this response. This will remove all configurations of the extension.
pub fn parse(buf: &[u8]) -> Result<Option<Response>>[src]
pub fn parse(buf: &[u8]) -> Result<Option<Response>>Attempt to parse an HTTP response from a buffer. If the buffer does not contain a complete
response, thiw will return Ok(None).
pub fn from_request(req: &Request) -> Result<Response>[src]
pub fn from_request(req: &Request) -> Result<Response>Construct a new WebSocket handshake HTTP response from a request. This will create a response that ignores protocols and extensions. Edit this response to accept a protocol and extensions as necessary.
pub fn format<W>(&self, w: &mut W) -> Result<()> where
W: Write, [src]
pub fn format<W>(&self, w: &mut W) -> Result<()> where
W: Write, Write a response out to a buffer
Trait Implementations
impl Debug for Response[src]
impl Debug for Responsefn fmt(&self, f: &mut Formatter) -> Result[src]
fn fmt(&self, f: &mut Formatter) -> ResultFormats the value using the given formatter. Read more
impl Display for Response[src]
impl Display for Response