#[non_exhaustive]pub struct Config {
pub read_buffer_size: usize,
pub write_buffer_size: usize,
pub max_write_buffer_size: usize,
pub max_message_size: Option<usize>,
pub max_frame_size: Option<usize>,
pub accept_unmasked_frames: bool,
}Expand description
WebSocket connection configuration.
The default configuration for a WebSocket can be changed by calling
WebSocket::config() with a value of this type, which replaces the
default configuration entirely. Values are obtained via
Default::default() and changed with builder methods.
By default, each connection allocates an 8KiB read buffer when it is
created. Config::default(), however, uses a 128KiB read buffer. Unless
Config::read_buffer_size() is used to set a smaller size, applications
with many mostly idle connections may use considerably more memory with a
custom configuration. Larger buffers can improve performance when reading
many messages.
The read buffer size does not limit the size of incoming messages. Use
Config::max_message_size() and Config::max_frame_size() to set
limits.
§Example
use rocket::data::ToByteUnit;
#[get("/echo")]
fn echo_stream(ws: ws::WebSocket) -> ws::Stream!['static] {
let config = ws::Config::default()
// Keep the 8KiB read buffer that is used by default.
.read_buffer_size(8.kibibytes().as_u64() as usize)
// Decrease the maximum (complete) message size to 4MiB.
.max_message_size(Some(4.mebibytes().as_u64() as usize))
// Decrease the maximum size of _one_ frame (not message) to 1MiB.
.max_frame_size(Some(1.mebibytes().as_u64() as usize));
let ws = ws.config(config);
ws::Stream! { ws =>
for await message in ws {
yield message?;
}
}
}Original tungstenite Documentation Follows
The configuration for WebSocket connection.
§Example
let conf = WebSocketConfig::default()
.read_buffer_size(256 * 1024)
.write_buffer_size(256 * 1024);Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.read_buffer_size: usizeRead buffer capacity. This buffer is eagerly allocated and used for receiving messages.
For high read load scenarios a larger buffer, e.g. 128 KiB, improves performance.
For scenarios where you expect a lot of connections and don’t need high read load performance a smaller buffer, e.g. 4 KiB, would be appropriate to lower total memory usage.
The default value is 128 KiB.
write_buffer_size: usizeThe target minimum size of the write buffer to reach before writing the data to the underlying stream. The default value is 128 KiB.
If set to 0 each message will be eagerly written to the underlying stream.
It is often more optimal to allow them to buffer a little, hence the default value.
Note: flush will always fully write the buffer regardless.
max_write_buffer_size: usizeThe max size of the write buffer in bytes. Setting this can provide backpressure in the case the write buffer is filling up due to write errors. The default value is unlimited.
Note: The write buffer only builds up past write_buffer_size
when writes to the underlying stream are failing. So the write buffer can not
fill up if you are not observing write errors even if not flushing.
Note: Should always be at least write_buffer_size + 1 message
and probably a little more depending on error handling strategy.
max_message_size: Option<usize>The maximum size of an incoming message. None means no size limit. The default value is 64 MiB
which should be reasonably big for all normal use-cases but small enough to prevent
memory eating by a malicious user.
max_frame_size: Option<usize>The maximum size of a single incoming message frame. None means no size limit. The limit is for
frame payload NOT including the frame header. The default value is 16 MiB which should
be reasonably big for all normal use-cases but small enough to prevent memory eating
by a malicious user.
accept_unmasked_frames: boolWhen set to true, the server will accept and handle unmasked frames
from the client. According to the RFC 6455, the server must close the
connection to the client in such cases, however it seems like there are
some popular libraries that are sending unmasked frames, ignoring the RFC.
By default this option is set to false, i.e. according to RFC 6455.
Implementations§
Source§impl WebSocketConfig
impl WebSocketConfig
Sourcepub fn read_buffer_size(self, read_buffer_size: usize) -> WebSocketConfig
pub fn read_buffer_size(self, read_buffer_size: usize) -> WebSocketConfig
Sourcepub fn write_buffer_size(self, write_buffer_size: usize) -> WebSocketConfig
pub fn write_buffer_size(self, write_buffer_size: usize) -> WebSocketConfig
Sourcepub fn max_write_buffer_size(
self,
max_write_buffer_size: usize,
) -> WebSocketConfig
pub fn max_write_buffer_size( self, max_write_buffer_size: usize, ) -> WebSocketConfig
Sourcepub fn max_message_size(
self,
max_message_size: Option<usize>,
) -> WebSocketConfig
pub fn max_message_size( self, max_message_size: Option<usize>, ) -> WebSocketConfig
Sourcepub fn max_frame_size(self, max_frame_size: Option<usize>) -> WebSocketConfig
pub fn max_frame_size(self, max_frame_size: Option<usize>) -> WebSocketConfig
Set Self::max_frame_size.
Sourcepub fn accept_unmasked_frames(
self,
accept_unmasked_frames: bool,
) -> WebSocketConfig
pub fn accept_unmasked_frames( self, accept_unmasked_frames: bool, ) -> WebSocketConfig
Trait Implementations§
Source§impl Clone for WebSocketConfig
impl Clone for WebSocketConfig
Source§fn clone(&self) -> WebSocketConfig
fn clone(&self) -> WebSocketConfig
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreimpl Copy for WebSocketConfig
Source§impl Debug for WebSocketConfig
impl Debug for WebSocketConfig
Source§impl Default for WebSocketConfig
impl Default for WebSocketConfig
Source§fn default() -> WebSocketConfig
fn default() -> WebSocketConfig
Auto Trait Implementations§
impl Forget for WebSocketConfig
impl Freeze for WebSocketConfig
impl Move for WebSocketConfig
impl RefUnwindSafe for WebSocketConfig
impl Send for WebSocketConfig
impl Sync for WebSocketConfig
impl Unpin for WebSocketConfig
impl UnsafeUnpin for WebSocketConfig
impl UnwindSafe for WebSocketConfig
Blanket Implementations§
Source§impl<T> AsAny for Twhere
T: Any,
impl<T> AsAny for Twhere
T: Any,
fn as_any_ref(&self) -> &(dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Source§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
Source§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
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
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);