Enum HandshakeError

Source

#[non_exhaustive]pub enum HandshakeError {
    BadCommand,
    WrongArity(usize),
    BadFromKeyword,
    BadGeneration,
    BadOffset,
    BadIdKeyword,
    BadReplicaId,
}

Expand description

Why HandshakeReq::parse rejected its input.

use kevy_replicate::handshake::{HandshakeError, HandshakeReq};

let argv = |w: &[&str]| kevy_resp::Argv::from(w.iter().map(|w| w.as_bytes().to_vec()).collect::<Vec<_>>());
let err = HandshakeReq::parse(&argv(&["REPLICATE", "FROM", "0", "0", "ID", ""])).unwrap_err();
assert_eq!(err, HandshakeError::BadReplicaId);
assert_eq!(err.to_string(), "replica id must be non-empty UTF-8");

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

§

BadCommand

First arg is not “REPLICATE” (case-insensitive).

use kevy_replicate::handshake::{HandshakeError, HandshakeReq};

let argv = |w: &[&str]| kevy_resp::Argv::from(w.iter().map(|w| w.as_bytes().to_vec()).collect::<Vec<_>>());
let err = HandshakeReq::parse(&argv(&["SYNC", "FROM", "0", "0", "ID", "r1"])).unwrap_err();
assert_eq!(err, HandshakeError::BadCommand);

§

WrongArity(usize)

Argument count is not exactly 6.

use kevy_replicate::handshake::{HandshakeError, HandshakeReq};

let argv = |w: &[&str]| kevy_resp::Argv::from(w.iter().map(|w| w.as_bytes().to_vec()).collect::<Vec<_>>());
let err = HandshakeReq::parse(&argv(&["REPLICATE", "FROM", "0", "ID", "r1"])).unwrap_err();
assert_eq!(err, HandshakeError::WrongArity(5));

§

BadFromKeyword

Second arg is not “FROM” (case-insensitive).

use kevy_replicate::handshake::{HandshakeError, HandshakeReq};

let argv = |w: &[&str]| kevy_resp::Argv::from(w.iter().map(|w| w.as_bytes().to_vec()).collect::<Vec<_>>());
let err = HandshakeReq::parse(&argv(&["REPLICATE", "AT", "0", "0", "ID", "r1"])).unwrap_err();
assert_eq!(err, HandshakeError::BadFromKeyword);

§

BadGeneration

Third arg (generation) did not parse as an unsigned decimal u64.

use kevy_replicate::handshake::{HandshakeError, HandshakeReq};

let argv = |w: &[&str]| kevy_resp::Argv::from(w.iter().map(|w| w.as_bytes().to_vec()).collect::<Vec<_>>());
let err = HandshakeReq::parse(&argv(&["REPLICATE", "FROM", "g1", "0", "ID", "r1"])).unwrap_err();
assert_eq!(err, HandshakeError::BadGeneration);

§

BadOffset

Fourth arg (offset) did not parse as an unsigned decimal u64.

use kevy_replicate::handshake::{HandshakeError, HandshakeReq};

let argv = |w: &[&str]| kevy_resp::Argv::from(w.iter().map(|w| w.as_bytes().to_vec()).collect::<Vec<_>>());
let err = HandshakeReq::parse(&argv(&["REPLICATE", "FROM", "1", "-1", "ID", "r1"])).unwrap_err();
assert_eq!(err, HandshakeError::BadOffset);

§

BadIdKeyword

Fifth arg is not “ID” (case-insensitive).

use kevy_replicate::handshake::{HandshakeError, HandshakeReq};

let argv = |w: &[&str]| kevy_resp::Argv::from(w.iter().map(|w| w.as_bytes().to_vec()).collect::<Vec<_>>());
let err = HandshakeReq::parse(&argv(&["REPLICATE", "FROM", "0", "0", "NAME", "r1"])).unwrap_err();
assert_eq!(err, HandshakeError::BadIdKeyword);

§

BadReplicaId

Replica id is empty or not valid UTF-8.

use kevy_replicate::handshake::{HandshakeError, HandshakeReq};

let argv = |w: &[&str]| kevy_resp::Argv::from(w.iter().map(|w| w.as_bytes().to_vec()).collect::<Vec<_>>());
let err = HandshakeReq::parse(&argv(&["REPLICATE", "FROM", "0", "0", "ID", ""])).unwrap_err();
assert_eq!(err, HandshakeError::BadReplicaId);