1
0
mirror of https://github.com/actix/actix-extras.git synced 2024-11-23 15:51:06 +01:00

docs: remove unnecessary code block annotations

This commit is contained in:
Rob Ede 2024-06-09 05:18:43 +01:00
parent 65c698cd7f
commit 3ae4ef2706
No known key found for this signature in database
GPG Key ID: 97C636207D3EF933
3 changed files with 9 additions and 9 deletions

View File

@ -7,7 +7,7 @@ use derive_more::{Display, From};
/// Session keys are stored as cookies, therefore they cannot be arbitrary long. Session keys are /// Session keys are stored as cookies, therefore they cannot be arbitrary long. Session keys are
/// required to be smaller than 4064 bytes. /// required to be smaller than 4064 bytes.
/// ///
/// ```rust /// ```
/// use actix_session::storage::SessionKey; /// use actix_session::storage::SessionKey;
/// ///
/// let key: String = std::iter::repeat('a').take(4065).collect(); /// let key: String = std::iter::repeat('a').take(4065).collect();

View File

@ -65,7 +65,7 @@ impl MessageStream {
/// Wait for the next item from the message stream /// Wait for the next item from the message stream
/// ///
/// ```rust,no_run /// ```no_run
/// # use actix_ws::MessageStream; /// # use actix_ws::MessageStream;
/// # async fn test(mut stream: MessageStream) { /// # async fn test(mut stream: MessageStream) {
/// while let Some(Ok(msg)) = stream.recv().await { /// while let Some(Ok(msg)) = stream.recv().await {

View File

@ -45,7 +45,7 @@ impl Session {
/// Send text into the websocket /// Send text into the websocket
/// ///
/// ```rust,no_run /// ```no_run
/// # use actix_ws::Session; /// # use actix_ws::Session;
/// # async fn test(mut session: Session) { /// # async fn test(mut session: Session) {
/// if session.text("Some text").await.is_err() { /// if session.text("Some text").await.is_err() {
@ -67,7 +67,7 @@ impl Session {
/// Send raw bytes into the websocket /// Send raw bytes into the websocket
/// ///
/// ```rust,no_run /// ```no_run
/// # use actix_ws::Session; /// # use actix_ws::Session;
/// # async fn test(mut session: Session) { /// # async fn test(mut session: Session) {
/// if session.binary(&b"some bytes"[..]).await.is_err() { /// if session.binary(&b"some bytes"[..]).await.is_err() {
@ -92,7 +92,7 @@ impl Session {
/// For many applications, it will be important to send regular pings to keep track of if the /// For many applications, it will be important to send regular pings to keep track of if the
/// client has disconnected /// client has disconnected
/// ///
/// ```rust,no_run /// ```no_run
/// # use actix_ws::Session; /// # use actix_ws::Session;
/// # async fn test(mut session: Session) { /// # async fn test(mut session: Session) {
/// if session.ping(b"").await.is_err() { /// if session.ping(b"").await.is_err() {
@ -114,7 +114,7 @@ impl Session {
/// Pong the client /// Pong the client
/// ///
/// ```rust,no_run /// ```no_run
/// # use actix_ws::{Message, Session}; /// # use actix_ws::{Message, Session};
/// # async fn test(mut session: Session, msg: Message) { /// # async fn test(mut session: Session, msg: Message) {
/// match msg { /// match msg {
@ -140,14 +140,14 @@ impl Session {
/// ///
/// Be wary of this method. Continuations represent multiple frames that, when combined, are /// Be wary of this method. Continuations represent multiple frames that, when combined, are
/// presented as a single message. They are useful when the entire contents of a message are /// presented as a single message. They are useful when the entire contents of a message are
/// not avilable all at once. However, continuations MUST NOT be interrupted by other Text or /// not available all at once. However, continuations MUST NOT be interrupted by other Text or
/// Binary messages. Control messages such as Ping, Pong, or Close are allowed to interrupt a /// Binary messages. Control messages such as Ping, Pong, or Close are allowed to interrupt a
/// continuation. /// continuation.
/// ///
/// Continuations must be initialized with a First variant, and must be terminated by a Last /// Continuations must be initialized with a First variant, and must be terminated by a Last
/// variant, with only Continue variants sent in between. /// variant, with only Continue variants sent in between.
/// ///
/// ```rust,no_run /// ```no_run
/// # use actix_ws::{Item, Session}; /// # use actix_ws::{Item, Session};
/// # async fn test(mut session: Session) -> Result<(), Box<dyn std::error::Error>> { /// # async fn test(mut session: Session) -> Result<(), Box<dyn std::error::Error>> {
/// session.continuation(Item::FirstText("Hello".into())).await?; /// session.continuation(Item::FirstText("Hello".into())).await?;
@ -172,7 +172,7 @@ impl Session {
/// ///
/// All clones will return `Err(Closed)` if used after this call /// All clones will return `Err(Closed)` if used after this call
/// ///
/// ```rust,no_run /// ```no_run
/// # use actix_ws::{Closed, Session}; /// # use actix_ws::{Closed, Session};
/// # async fn test(mut session: Session) -> Result<(), Closed> { /// # async fn test(mut session: Session) -> Result<(), Closed> {
/// session.close(None).await /// session.close(None).await