1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

//! Data format used to communicate with openssh mux server.
//!
//! Format details:
//!  - All integers are encoded in big endian;
//!  - Boolean are encoded as `u32` according to [here][1];
//!  - `char` are encoded as `u32`;
//!  - Strings and bytes are encoded as length(`u32`) + content, same as [`sshbuf_put_string`];
//!  - `Option::None` are omitted while `Option::Some(v)` has the same encoding as `v` since
//!    openssh mux protocol allows optional parameter at the end of the message;
//!  - struct/tuple are encoded as-is, unit struct/tuple are omitted;
//!  - sequence are encoded as if it is a tuple according to [here][0], thus it cannot be
//!    deserialized;
//!  - Variant is encoded as index(`u32`) + content encoded as-is (it is expected to
//!    manually implement `Serialize` and `Deserialize` to ensure the `variant_index`
//!    is the one you expected);
//!  - Serializing/Deserializing map is unsupported;
//!
//! [`sshbuf_put_string`]: https://github.com/openssh/openssh-portable/blob/2dc328023f60212cd29504fc05d849133ae47355/sshbuf-getput-basic.c#L514
//! [0]: https://github.com/openssh/openssh-portable/blob/19b3d846f06697c85957ab79a63454f57f8e22d6/mux.c#L1906
//! [1]: https://github.com/openssh/openssh-portable/blob/19b3d846f06697c85957ab79a63454f57f8e22d6/mux.c#L1897
//! ## Feature
//!  - `is_human_readable` enables `Serializer::is_human_readable` and
//!    `Deserializer::is_human_readable`.
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
#![forbid(unsafe_code)]

mod de;
mod ser;
mod ser_output;

pub use de::{from_bytes, Deserializer};
pub use ser::{to_bytes, Serializer};
pub use ser_output::SerOutput;
pub use ssh_format_error::{Error, Result};