berkus
/
bincode
mirror of https://git.sr.ht/~stygianentity/bincode
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix a bunch of typos (#492)

This commit is contained in:
poljar 2022-01-25 12:13:38 +01:00 committed by GitHub
parent 3c64d7dbbe
commit 306a772835
3 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -70,7 +70,7 @@ Bincode's format is specified in [docs/spec.md](https://github.com/bincode-org/b
The encoding format is stable, provided the same configuration is used. The encoding format is stable, provided the same configuration is used.
This should ensure that later versions can still read data produced by a previous versions of the library if no major version change This should ensure that later versions can still read data produced by a previous versions of the library if no major version change
has occured. has occurred.
Bincode 1 and 2 are completely compatible if the same configuration is used. Bincode 1 and 2 are completely compatible if the same configuration is used.
@ -99,7 +99,7 @@ maximum size limit. Malicious inputs will fail upon deserialization.
### What is Bincode's MSRV (minimum supported Rust version)? ### What is Bincode's MSRV (minimum supported Rust version)?
Bincode 2.0 is still in development and does not yet have a targetted MSRV. Once 2.0 is fully released the MSRV will be locked. After this point any changes to the MSRV are considered a breaking change for semver purposes. Bincode 2.0 is still in development and does not yet have a targeted MSRV. Once 2.0 is fully released the MSRV will be locked. After this point any changes to the MSRV are considered a breaking change for semver purposes.
### Why does bincode not respect `#[repr(u8)]`? ### Why does bincode not respect `#[repr(u8)]`?

16
src/error.rs
View File

@ -15,10 +15,10 @@ pub enum EncodeError {
type_name: &'static str, type_name: &'static str,
}, },
/// An uncommon error occured, see the inner text for more information /// An uncommon error occurred, see the inner text for more information
Other(&'static str), Other(&'static str),
/// An uncommon error occured, see the inner text for more information /// An uncommon error occurred, see the inner text for more information
#[cfg(feature = "alloc")] #[cfg(feature = "alloc")]
OtherString(alloc::string::String), OtherString(alloc::string::String),
@ -26,12 +26,12 @@ pub enum EncodeError {
#[cfg(feature = "std")] #[cfg(feature = "std")]
InvalidPathCharacters, InvalidPathCharacters,
/// The targetted writer encountered an `std::io::Error` /// The targeted writer encountered an `std::io::Error`
#[cfg(feature = "std")] #[cfg(feature = "std")]
Io { Io {
/// The encountered error /// The encountered error
error: std::io::Error, error: std::io::Error,
/// The amount of bytes that were written before the error occured /// The amount of bytes that were written before the error occurred
index: usize, index: usize,
}, },
@ -52,7 +52,7 @@ pub enum EncodeError {
}, },
#[cfg(feature = "serde")] #[cfg(feature = "serde")]
/// A serde-specific error that occured while decoding. /// A serde-specific error that occurred while decoding.
Serde(crate::features::serde::EncodeError), Serde(crate::features::serde::EncodeError),
} }
@ -63,7 +63,7 @@ impl core::fmt::Display for EncodeError {
} }
} }
/// Errors that can be encounted by decoding a type /// Errors that can be encountered by decoding a type
#[non_exhaustive] #[non_exhaustive]
#[derive(Debug, PartialEq)] #[derive(Debug, PartialEq)]
pub enum DecodeError { pub enum DecodeError {
@ -153,12 +153,12 @@ pub enum DecodeError {
inner: std::ffi::FromVecWithNulError, inner: std::ffi::FromVecWithNulError,
}, },
/// An uncommon error occured, see the inner text for more information /// An uncommon error occurred, see the inner text for more information
#[cfg(feature = "alloc")] #[cfg(feature = "alloc")]
OtherString(alloc::string::String), OtherString(alloc::string::String),
#[cfg(feature = "serde")] #[cfg(feature = "serde")]
/// A serde-specific error that occured while decoding. /// A serde-specific error that occurred while decoding.
Serde(crate::features::serde::DecodeError), Serde(crate::features::serde::DecodeError),
} }

4
src/features/serde/mod.rs
View File

@ -73,7 +73,7 @@ pub use self::de_borrowed::*;
pub use self::de_owned::*; pub use self::de_owned::*;
pub use self::ser::*; pub use self::ser::*;
/// A serde-specific error that occured while decoding. /// A serde-specific error that occurred while decoding.
#[derive(Debug, PartialEq)] #[derive(Debug, PartialEq)]
#[non_exhaustive] #[non_exhaustive]
pub enum DecodeError { pub enum DecodeError {
@ -129,7 +129,7 @@ impl Into<crate::error::DecodeError> for DecodeError {
} }
} }
/// A serde-specific error that occured while encoding. /// A serde-specific error that occurred while encoding.
#[derive(Debug, PartialEq)] #[derive(Debug, PartialEq)]
#[non_exhaustive] #[non_exhaustive]
pub enum EncodeError { pub enum EncodeError {