Skip to content

fix: Repair doc tests #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Techassi merged 1 commit into from
Sep 22, 2024
Merged

fix: Repair doc tests #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,10 @@
//! ## Reading Simple Data Types
//!
//! ```rust
//! # use binbuf::*;
//!
//! let b = &[69, 88, 65, 77, 80, 76, 69, 33];
//! let mut b = ReadBuffer::new(b);
//! let mut b = Reader::new(b);
//!
//! match u16::read::<BigEndian>(&mut b) {
//! Ok(n) => assert_eq!(n, 17752),
Expand Down
66 changes: 33 additions & 33 deletions src/read.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,9 @@ impl<'a> Reader<'a> {
/// ### Example
///
/// ```
/// use binbuf::read::{Buffer, Error};
/// use binbuf::{Reader, read::Error};
///
/// let mut b = Buffer::new(&[69, 88]);
/// let mut b = Reader::new(&[69, 88]);
///
/// assert_eq!(b.pop(), Ok(69));
/// assert_eq!(b.pop(), Ok(88));
Expand Down Expand Up @@ -117,9 +117,9 @@ impl<'a> Reader<'a> {
/// ### Example
///
/// ```
/// use binbuf::read::Buffer;
/// use binbuf::Reader;
///
/// let mut b = Buffer::new(&[69]);
/// let mut b = Reader::new(&[69]);
///
/// assert_eq!(b.peek(), Some(69));
/// assert_eq!(b.pop(), Ok(69));
Expand All @@ -135,9 +135,9 @@ impl<'a> Reader<'a> {
/// ### Example
///
/// ```
/// use binbuf::read::Buffer;
/// use binbuf::Reader;
///
/// let mut b = Buffer::new(&[69, 88]);
/// let mut b = Reader::new(&[69, 88]);
///
/// assert_eq!(b.peekn::<2>(), Some([69, 88]));
/// assert_eq!(b.skipn(2), Ok(()));
Expand Down Expand Up @@ -201,9 +201,9 @@ impl<'a> Reader<'a> {
/// ### Example
///
/// ```
/// use binbuf::read::Buffer;
/// use binbuf::Reader;
///
/// let mut b = Buffer::new(&[69, 88]);
/// let mut b = Reader::new(&[69, 88]);
///
/// assert_eq!(b.pop(), Ok(69));
/// assert_eq!(b.offset(), 1);
Expand All @@ -217,9 +217,9 @@ impl<'a> Reader<'a> {
/// ### Example
///
/// ```
/// use binbuf::read::Buffer;
/// use binbuf::Reader;
///
/// let mut b = Buffer::new(&[69, 88]);
/// let mut b = Reader::new(&[69, 88]);
///
/// assert_eq!(b.len(), 2);
/// assert_eq!(b.pop(), Ok(69));
Expand All @@ -234,9 +234,9 @@ impl<'a> Reader<'a> {
/// ### Example
///
/// ```
/// use binbuf::read::Buffer;
/// use binbuf::Reader;
///
/// let mut b = Buffer::new(&[69]);
/// let mut b = Reader::new(&[69]);
///
/// assert_eq!(b.is_empty(), false);
/// assert_eq!(b.pop(), Ok(69));
Expand All @@ -262,22 +262,22 @@ impl<'a> Reader<'a> {
/// ### Example
///
/// ```
/// use binbuf::read::Buffer;
/// use binbuf::Reader;
///
/// let d = &[4, 88, 65, 77, 80, 76, 69, 33];
/// let mut b = Buffer::new(d);
/// let mut b = Reader::new(d);
///
/// assert_eq!(b.read_char_string(None), Ok(&[88, 65, 77, 80]));
/// assert_eq!(b.read_char_string(None), Ok([88, 65, 77, 80].as_slice()));
/// assert_eq!(b.len(), 3);
/// ```
///
/// ### Example with a maximum length
///
/// ```
/// use binbuf::read::{Buffer, Error};
/// use binbuf::{Reader, read::Error};
///
/// let d = &[4, 88, 65, 77, 80, 76, 69, 33];
/// let mut b = Buffer::new(d);
/// let mut b = Reader::new(d);
///
/// assert_eq!(b.read_char_string(Some(3)), Err(Error::MaxLengthOverflow));
/// assert_eq!(b.len(), 8);
Expand All @@ -300,12 +300,12 @@ impl<'a> Reader<'a> {
/// ### Example
///
/// ```
/// use binbuf::read::Buffer;
/// use binbuf::Reader;
///
/// let d = &[69, 88, 65, 77, 80, 76, 69, 33];
/// let mut b = Buffer::new(d);
/// let mut b = Reader::new(d);
///
/// assert_eq!(b.read_slice(4), Ok(&[69, 88, 65, 77]));
/// assert_eq!(b.read_slice(4), Ok([69, 88, 65, 77].as_slice()));
/// assert_eq!(b.len(), 4);
/// ```
pub fn read_slice(&mut self, nbytes: usize) -> Result<&[u8]> {
Expand All @@ -322,10 +322,10 @@ impl<'a> Reader<'a> {
/// ### Example
///
/// ```
/// use binbuf::read::Buffer;
/// use binbuf::Reader;
///
/// let d = &[69, 88, 65, 77, 80, 76, 69, 33];
/// let mut b = Buffer::new(d);
/// let mut b = Reader::new(d);
///
/// assert_eq!(b.read_vec(4), Ok(vec![69, 88, 65, 77]));
/// assert_eq!(b.len(), 4);
Expand All @@ -342,10 +342,10 @@ impl<'a> Reader<'a> {
/// ### Example
///
/// ```
/// use binbuf::{BigEndian, read::{Buffer, Readable}};
/// use binbuf::{BigEndian, Reader, Read as _};
///
/// let d = &[69, 88, 65, 77, 80, 76, 69, 33];
/// let mut b = Buffer::new(d);
/// let mut b = Reader::new(d);
///
/// assert_eq!(u16::read::<BigEndian>(&mut b), Ok(17752));
/// ```
Expand All @@ -355,7 +355,7 @@ pub trait Read: Sized {
/// ### Example
///
/// ```
/// use binbuf::prelude::*;
/// use binbuf::{BigEndian, Reader, Read as _};
///
/// let d = vec![69, 88, 65, 77, 80, 76, 69, 33];
/// let mut r = Reader::new(d.as_slice());
Expand All @@ -375,10 +375,10 @@ pub trait Read: Sized {
/// ### Example
///
/// ```
/// use binbuf::prelude::*;
/// use binbuf::{Reader, Read as _};
///
/// let d = vec![69, 88, 65, 77, 80, 76, 69, 33];
/// let mut b = ReadBuffer::new(d.as_slice());
/// let mut b = Reader::new(d.as_slice());
///
/// let i = u16::read_be(&mut b).unwrap();
/// assert_eq!(i, 17752);
Expand All @@ -397,10 +397,10 @@ pub trait Read: Sized {
/// ### Example
///
/// ```
/// use binbuf::prelude::*;
/// use binbuf::{Reader, Read as _};
///
/// let d = vec![69, 88, 65, 77, 80, 76, 69, 33];
/// let mut b = ReadBuffer::new(d.as_slice());
/// let mut b = Reader::new(d.as_slice());
///
/// let i = u16::read_le(&mut b).unwrap();
/// assert_eq!(i, 22597);
Expand All @@ -418,10 +418,10 @@ pub trait Read: Sized {
/// ### Example
///
/// ```
/// use binbuf::prelude::*;
/// use binbuf::{BigEndian, Reader, ReadableMulti as _};
///
/// let d = vec![69, 88, 65, 77, 80, 76, 69, 33];
/// let mut b = ReadBuffer::new(d.as_slice());
/// let mut b = Reader::new(d.as_slice());
///
/// let [i1, i2] = u16::read_multi::<BigEndian, 2>(&mut b).unwrap();
///
Expand All @@ -434,10 +434,10 @@ pub trait ReadableMulti: Read + Default + Copy {
/// ### Example
///
/// ```
/// use binbuf::prelude::*;
/// use binbuf::{BigEndian, Reader, ReadableMulti as _};
///
/// let d = vec![69, 88, 65, 77, 80, 76, 69, 33];
/// let mut b = ReadBuffer::new(d.as_slice());
/// let mut b = Reader::new(d.as_slice());
///
/// let [i1, i2, i3, i4] = u16::read_multi::<BigEndian, 4>(&mut b).unwrap();
///
Expand Down
32 changes: 16 additions & 16 deletions src/write.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ impl Writer {
/// ### Example
///
/// ```
/// use binbuf::write::Buffer;
/// use binbuf::{BigEndian, Write as _, Writer};
///
/// let mut b = Buffer::new();
/// let mut b = Writer::new();
/// 17752u16.write::<BigEndian>(&mut b).unwrap();
///
/// assert_eq!(b.len(), 2);
Expand All @@ -55,9 +55,9 @@ impl Writer {
/// ### Example
///
/// ```
/// use binbuf::write::Buffer;
/// use binbuf::Writer;
///
/// let mut b = Buffer::new_with([69, 88]);
/// let mut b = Writer::new_with([69, 88]);
/// assert_eq!(b.bytes(), &[69, 88]);
/// ```
pub fn new_with<T: AsRef<[u8]>>(b: T) -> Self {
Expand All @@ -76,9 +76,9 @@ impl Writer {
/// ### Example
///
/// ```
/// use binbuf::write::Buffer;
/// use binbuf::Writer;
///
/// let mut b = Buffer::new();
/// let mut b = Writer::new();
/// b.push(69);
///
/// assert_eq!(b.len(), 1);
Expand All @@ -97,9 +97,9 @@ impl Writer {
/// ### Example
///
/// ```
/// use binbuf::write::Buffer;
/// use binbuf::Writer;
///
/// let mut b = Buffer::new_with([69, 88]);
/// let mut b = Writer::new_with([69, 88]);
/// b.clear();
///
/// assert_eq!(b.len(), 0);
Expand All @@ -113,9 +113,9 @@ impl Writer {
/// ### Example
///
/// ```
/// use binbuf::write::Buffer;
/// use binbuf::Writer;
///
/// let mut b = Buffer::new_with([69, 88]);
/// let mut b = Writer::new_with([69, 88]);
/// assert_eq!(b.len(), 2);
/// ```
pub fn len(&self) -> usize {
Expand All @@ -127,9 +127,9 @@ impl Writer {
/// ### Example
///
/// ```
/// use binbuf::write::Buffer;
/// use binbuf::Writer;
///
/// let mut b = Buffer::new();
/// let mut b = Writer::new();
/// assert_eq!(b.is_empty(), true);
///
/// b.push(69);
Expand All @@ -145,9 +145,9 @@ impl Writer {
/// ### Example
///
/// ```
/// use binbuf::write::Buffer;
/// use binbuf::Writer;
///
/// let mut b = Buffer::new();
/// let mut b = Writer::new();
/// b.write(vec![69, 88, 65]);
///
/// assert_eq!(b.len(), 3);
Expand Down Expand Up @@ -186,9 +186,9 @@ impl Writer {
/// ### Example
///
/// ```
/// use binbuf::write::Buffer;
/// use binbuf::Writer;
///
/// let mut b = Buffer::new();
/// let mut b = Writer::new();
/// b.write_char_string(&[88, 65, 77, 80], None).unwrap();
///
/// assert_eq!(b.len(), 5);
Expand Down