bin_buffer 0.1.8

A simple library for writing objects to binairy buffers.
Documentation
Build #232389 2020-03-22 21:15:19

# rustc version rustc 1.44.0-nightly (38114ff16 2020-03-21)

# docs.rs version docsrs 0.6.0 (794c8db 2020-03-21)

# build log [INFO] running `"docker" "create" "-v" "/home/cratesfyi/workspace/builds/bin_buffer-0.1.8/target:/opt/rustwide/target:rw,Z" "-v" "/home/cratesfyi/workspace/builds/bin_buffer-0.1.8/source:/opt/rustwide/workdir:ro,Z" "-v" "/home/cratesfyi/workspace/cargo-home:/opt/rustwide/cargo-home:ro,Z" "-v" "/home/cratesfyi/workspace/rustup-home:/opt/rustwide/rustup-home:ro,Z" "-e" "SOURCE_DIR=/opt/rustwide/workdir" "-e" "MAP_USER_ID=1001" "-e" "CARGO_TARGET_DIR=/opt/rustwide/target" "-e" "RUSTFLAGS=" "-e" "RUSTDOCFLAGS=-Z unstable-options --resource-suffix -20200321-1.44.0-nightly-38114ff16 --static-root-path / --extern-html-root-url fnrs=https://docs.rs/fnrs/0.1.4" "-e" "CARGO_HOME=/opt/rustwide/cargo-home" "-e" "RUSTUP_HOME=/opt/rustwide/rustup-home" "-w" "/opt/rustwide/workdir" "-m" "3221225472" "--network" "none" "rustops/crates-build-env" "/opt/rustwide/cargo-home/bin/cargo" "+nightly" "doc" "--lib" "--no-deps"` [INFO] [stderr] WARNING: Your kernel does not support swap limit capabilities or the cgroup is not mounted. Memory limited without swap. [INFO] [stdout] 69aac8d5e1a7e9412418383833e63eb06675d93fccc2eabfc8cebd037ca3c892 [INFO] running `"docker" "start" "-a" "69aac8d5e1a7e9412418383833e63eb06675d93fccc2eabfc8cebd037ca3c892"` [INFO] [stderr] Checking fnrs v0.1.4 [INFO] [stderr] Documenting bin_buffer v0.1.8 (/opt/rustwide/workdir) [INFO] [stderr] warning: missing code example in this documentation [INFO] [stderr] --> src/lib.rs:29:1 [INFO] [stderr] | [INFO] [stderr] 29 | /// Buffer from which we can read. [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] | [INFO] [stderr] note: the lint level is defined here [INFO] [stderr] --> src/lib.rs:2:9 [INFO] [stderr] | [INFO] [stderr] 2 | #![warn(missing_doc_code_examples)] [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] [INFO] [stderr] warning: missing code example in this documentation [INFO] [stderr] --> src/lib.rs:31:5 [INFO] [stderr] | [INFO] [stderr] 31 | buffer: Buffer, [INFO] [stderr] | ^^^^^^^^^^^^^^ [INFO] [stderr] [INFO] [stderr] warning: missing code example in this documentation [INFO] [stderr] --> src/lib.rs:32:5 [INFO] [stderr] | [INFO] [stderr] 32 | iter: usize, [INFO] [stderr] | ^^^^^^^^^^^ [INFO] [stderr] [INFO] [stderr] warning: missing code example in this documentation [INFO] [stderr] --> src/lib.rs:26:1 [INFO] [stderr] | [INFO] [stderr] 26 | /// Buffer: a Vector of bytes [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] [INFO] [stderr] warning: missing code example in this documentation [INFO] [stderr] --> src/lib.rs:53:1 [INFO] [stderr] | [INFO] [stderr] 53 | /// Object can be read and written to a Buffer [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] [INFO] [stderr] warning: missing code example in this documentation [INFO] [stderr] --> src/lib.rs:55:5 [INFO] [stderr] | [INFO] [stderr] 55 | /// Consume yourself and add to the end of the buffer [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] [INFO] [stderr] warning: missing code example in this documentation [INFO] [stderr] --> src/lib.rs:57:5 [INFO] [stderr] | [INFO] [stderr] 57 | /// Copy yourself and add to the end of the buffer. [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] [INFO] [stderr] warning: missing code example in this documentation [INFO] [stderr] --> src/lib.rs:59:5 [INFO] [stderr] | [INFO] [stderr] 59 | /// Read object from buffer [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] [INFO] [stderr] warning: missing code example in this documentation [INFO] [stderr] --> src/lib.rs:35:1 [INFO] [stderr] | [INFO] [stderr] 35 | / impl ReadBuffer{ [INFO] [stderr] 36 | | /// Create ReadBuffer from Buffer. [INFO] [stderr] 37 | | pub fn from_raw(vec: Buffer) -> Self{ [INFO] [stderr] 38 | | Self{ [INFO] [stderr] ... | [INFO] [stderr] 50 | | } [INFO] [stderr] 51 | | } [INFO] [stderr] | |_^ [INFO] [stderr] [INFO] [stderr] warning: missing code example in this documentation [INFO] [stderr] --> src/lib.rs:36:5 [INFO] [stderr] | [INFO] [stderr] 36 | /// Create ReadBuffer from Buffer. [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] [INFO] [stderr] warning: missing code example in this documentation [INFO] [stderr] --> src/lib.rs:43:5 [INFO] [stderr] | [INFO] [stderr] 43 | /// Turn ReadBuffer into Buffer. [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] [INFO] [stderr] warning: missing code example in this documentation [INFO] [stderr] --> src/lib.rs:47:5 [INFO] [stderr] | [INFO] [stderr] 47 | /// If the ReadBuffer is empty. [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] [INFO] [stderr] warning: missing code example in this documentation [INFO] [stderr] --> src/lib.rs:73:5 [INFO] [stderr] | [INFO] [stderr] 73 | / fn into_buffer(self, vec: &mut Buffer){ [INFO] [stderr] 74 | | vec.push(((self >> 56) & 0xff) as u8); [INFO] [stderr] 75 | | vec.push(((self >> 48) & 0xff) as u8); [INFO] [stderr] 76 | | vec.push(((self >> 40) & 0xff) as u8); [INFO] [stderr] ... | [INFO] [stderr] 81 | | vec.push((self & 0xff) as u8); [INFO] [stderr] 82 | | } [INFO] [stderr] | |_____^ [INFO] [stderr] [INFO] [stderr] warning: missing code example in this documentation [INFO] [stderr] --> src/lib.rs:84:5 [INFO] [stderr] | [INFO] [stderr] 84 | / fn copy_into_buffer(&self, vec: &mut Buffer){ [INFO] [stderr] 85 | | self.clone().into_buffer(vec); [INFO] [stderr] 86 | | } [INFO] [stderr] | |_____^ [INFO] [stderr] [INFO] [stderr] warning: missing code example in this documentation [INFO] [stderr] --> src/lib.rs:88:5 [INFO] [stderr] | [INFO] [stderr] 88 | / fn from_buffer(buf: &mut ReadBuffer) -> Option<Self>{ [INFO] [stderr] 89 | | if buf.iter + 8 > buf.buffer.len() { return Option::None; } [INFO] [stderr] 90 | | let mut val: u64 = 0; [INFO] [stderr] 91 | | val += u64::from(buf.buffer[(buf.iter )]) << 56; [INFO] [stderr] ... | [INFO] [stderr] 100 | | Option::Some(val) [INFO] [stderr] 101 | | } [INFO] [stderr] | |_____^ [INFO] [stderr] [INFO] [stderr] warning: missing code example in this documentation [INFO] [stderr] --> src/lib.rs:114:5 [INFO] [stderr] | [INFO] [stderr] 114 | / fn into_buffer(self, vec: &mut Buffer){ [INFO] [stderr] 115 | | vec.push(((self >> 24) & 0xff) as u8); [INFO] [stderr] 116 | | vec.push(((self >> 16) & 0xff) as u8); [INFO] [stderr] 117 | | vec.push(((self >> 8) & 0xff) as u8); [INFO] [stderr] 118 | | vec.push((self & 0xff) as u8); [INFO] [stderr] 119 | | } [INFO] [stderr] | |_____^ [INFO] [stderr] [INFO] [stderr] warning: missing code example in this documentation [INFO] [stderr] --> src/lib.rs:121:5 [INFO] [stderr] | [INFO] [stderr] 121 | / fn copy_into_buffer(&self, vec: &mut Buffer){ [INFO] [stderr] 122 | | self.clone().into_buffer(vec); [INFO] [stderr] 123 | | } [INFO] [stderr] | |_____^ [INFO] [stderr] [INFO] [stderr] warning: missing code example in this documentation [INFO] [stderr] --> src/lib.rs:125:5 [INFO] [stderr] | [INFO] [stderr] 125 | / fn from_buffer(buf: &mut ReadBuffer) -> Option<Self>{ [INFO] [stderr] 126 | | if buf.iter + 4 > buf.buffer.len() { return Option::None; } [INFO] [stderr] 127 | | let mut val: u32 = 0; [INFO] [stderr] 128 | | val += u32::from(buf.buffer[(buf.iter )]) << 24; [INFO] [stderr] ... | [INFO] [stderr] 133 | | Option::Some(val) [INFO] [stderr] 134 | | } [INFO] [stderr] | |_____^ [INFO] [stderr] [INFO] [stderr] warning: missing code example in this documentation [INFO] [stderr] --> src/lib.rs:147:5 [INFO] [stderr] | [INFO] [stderr] 147 | / fn into_buffer(self, vec: &mut Buffer){ [INFO] [stderr] 148 | | vec.push(((self >> 8) & 0xff) as u8); [INFO] [stderr] 149 | | vec.push((self & 0xff) as u8); [INFO] [stderr] 150 | | } [INFO] [stderr] | |_____^ [INFO] [stderr] [INFO] [stderr] warning: missing code example in this documentation [INFO] [stderr] --> src/lib.rs:152:5 [INFO] [stderr] | [INFO] [stderr] 152 | / fn copy_into_buffer(&self, vec: &mut Buffer){ [INFO] [stderr] 153 | | self.clone().into_buffer(vec); [INFO] [stderr] 154 | | } [INFO] [stderr] | |_____^ [INFO] [stderr] [INFO] [stderr] warning: missing code example in this documentation [INFO] [stderr] --> src/lib.rs:156:5 [INFO] [stderr] | [INFO] [stderr] 156 | / fn from_buffer(buf: &mut ReadBuffer) -> Option<Self>{ [INFO] [stderr] 157 | | if buf.iter + 2 > buf.buffer.len() { return Option::None; } [INFO] [stderr] 158 | | let mut val: u16 = 0; [INFO] [stderr] 159 | | val += u16::from(buf.buffer[(buf.iter )]) << 8; [INFO] [stderr] ... | [INFO] [stderr] 162 | | Option::Some(val) [INFO] [stderr] 163 | | } [INFO] [stderr] | |_____^ [INFO] [stderr] [INFO] [stderr] warning: missing code example in this documentation [INFO] [stderr] --> src/lib.rs:176:5 [INFO] [stderr] | [INFO] [stderr] 176 | / fn into_buffer(self, vec: &mut Buffer){ [INFO] [stderr] 177 | | vec.push(self); [INFO] [stderr] 178 | | } [INFO] [stderr] | |_____^ [INFO] [stderr] [INFO] [stderr] warning: missing code example in this documentation [INFO] [stderr] --> src/lib.rs:180:5 [INFO] [stderr] | [INFO] [stderr] 180 | / fn copy_into_buffer(&self, vec: &mut Buffer){ [INFO] [stderr] 181 | | self.clone().into_buffer(vec); [INFO] [stderr] 182 | | } [INFO] [stderr] | |_____^ [INFO] [stderr] [INFO] [stderr] warning: missing code example in this documentation [INFO] [stderr] --> src/lib.rs:184:5 [INFO] [stderr] | [INFO] [stderr] 184 | / fn from_buffer(buf: &mut ReadBuffer) -> Option<Self>{ [INFO] [stderr] 185 | | if buf.iter + 1 > buf.buffer.len() { return Option::None; } [INFO] [stderr] 186 | | let val = buf.buffer[buf.iter]; [INFO] [stderr] 187 | | buf.iter += 1; [INFO] [stderr] 188 | | Option::Some(val) [INFO] [stderr] 189 | | } [INFO] [stderr] | |_____^ [INFO] [stderr] [INFO] [stderr] warning: missing code example in this documentation [INFO] [stderr] --> src/lib.rs:202:5 [INFO] [stderr] | [INFO] [stderr] 202 | / fn into_buffer(self, vec: &mut Buffer){ [INFO] [stderr] 203 | | let bytes = self.to_be_bytes(); [INFO] [stderr] 204 | | for b in bytes.iter(){ [INFO] [stderr] 205 | | vec.push(*b); [INFO] [stderr] 206 | | } [INFO] [stderr] 207 | | } [INFO] [stderr] | |_____^ [INFO] [stderr] [INFO] [stderr] warning: missing code example in this documentation [INFO] [stderr] --> src/lib.rs:209:5 [INFO] [stderr] | [INFO] [stderr] 209 | / fn copy_into_buffer(&self, vec: &mut Buffer){ [INFO] [stderr] 210 | | self.clone().into_buffer(vec); [INFO] [stderr] 211 | | } [INFO] [stderr] | |_____^ [INFO] [stderr] [INFO] [stderr] warning: missing code example in this documentation [INFO] [stderr] --> src/lib.rs:213:5 [INFO] [stderr] | [INFO] [stderr] 213 | / fn from_buffer(buf: &mut ReadBuffer) -> Option<Self>{ [INFO] [stderr] 214 | | if buf.iter + 8 > buf.buffer.len() { return Option::None; } [INFO] [stderr] 215 | | let mut bytes = [0u8; 8]; [INFO] [stderr] 216 | | for (i, byte) in bytes.iter_mut().enumerate(){ [INFO] [stderr] ... | [INFO] [stderr] 220 | | Option::Some(f64::from_be_bytes(bytes)) [INFO] [stderr] 221 | | } [INFO] [stderr] | |_____^ [INFO] [stderr] [INFO] [stderr] warning: missing code example in this documentation [INFO] [stderr] --> src/lib.rs:234:5 [INFO] [stderr] | [INFO] [stderr] 234 | / fn into_buffer(self, vec: &mut Buffer){ [INFO] [stderr] 235 | | let bytes = self.to_be_bytes(); [INFO] [stderr] 236 | | for b in bytes.iter(){ [INFO] [stderr] 237 | | vec.push(*b); [INFO] [stderr] 238 | | } [INFO] [stderr] 239 | | } [INFO] [stderr] | |_____^ [INFO] [stderr] [INFO] [stderr] warning: missing code example in this documentation [INFO] [stderr] --> src/lib.rs:241:5 [INFO] [stderr] | [INFO] [stderr] 241 | / fn copy_into_buffer(&self, vec: &mut Buffer){ [INFO] [stderr] 242 | | self.clone().into_buffer(vec); [INFO] [stderr] 243 | | } [INFO] [stderr] | |_____^ [INFO] [stderr] [INFO] [stderr] warning: missing code example in this documentation [INFO] [stderr] --> src/lib.rs:245:5 [INFO] [stderr] | [INFO] [stderr] 245 | / fn from_buffer(buf: &mut ReadBuffer) -> Option<Self>{ [INFO] [stderr] 246 | | if buf.iter + 4 > buf.buffer.len() { return Option::None; } [INFO] [stderr] 247 | | let mut bytes = [0u8; 4]; [INFO] [stderr] 248 | | for (i,byte) in bytes.iter_mut().enumerate(){ [INFO] [stderr] ... | [INFO] [stderr] 252 | | Option::Some(f32::from_be_bytes(bytes)) [INFO] [stderr] 253 | | } [INFO] [stderr] | |_____^ [INFO] [stderr] [INFO] [stderr] warning: missing code example in this documentation [INFO] [stderr] --> src/lib.rs:266:5 [INFO] [stderr] | [INFO] [stderr] 266 | / fn into_buffer(self, vec: &mut Buffer){ [INFO] [stderr] 267 | | self.copy_into_buffer(vec); [INFO] [stderr] 268 | | } [INFO] [stderr] | |_____^ [INFO] [stderr] [INFO] [stderr] warning: missing code example in this documentation [INFO] [stderr] --> src/lib.rs:270:5 [INFO] [stderr] | [INFO] [stderr] 270 | / fn copy_into_buffer(&self, vec: &mut Buffer){ [INFO] [stderr] 271 | | let bytes = self.as_bytes(); [INFO] [stderr] 272 | | let len = bytes.len(); [INFO] [stderr] 273 | | (len as u64).into_buffer(vec); [INFO] [stderr] ... | [INFO] [stderr] 276 | | } [INFO] [stderr] 277 | | } [INFO] [stderr] | |_____^ [INFO] [stderr] [INFO] [stderr] warning: missing code example in this documentation [INFO] [stderr] --> src/lib.rs:279:5 [INFO] [stderr] | [INFO] [stderr] 279 | / fn from_buffer(buf: &mut ReadBuffer) -> Option<Self>{ [INFO] [stderr] 280 | | let len = uworn!(u64::from_buffer(buf)) as usize; [INFO] [stderr] 281 | | if buf.iter + len > buf.buffer.len() { return Option::None; } [INFO] [stderr] 282 | | let mut bytes = Vec::new(); [INFO] [stderr] ... | [INFO] [stderr] 288 | | else { Option::None } [INFO] [stderr] 289 | | } [INFO] [stderr] | |_____^ [INFO] [stderr] [INFO] [stderr] warning: missing code example in this documentation [INFO] [stderr] --> src/lib.rs:375:5 [INFO] [stderr] | [INFO] [stderr] 375 | / fn into_buffer(self, buf: &mut Buffer){ [INFO] [stderr] 376 | | let len = self.len() as u64; [INFO] [stderr] 377 | | len.into_buffer(buf); [INFO] [stderr] 378 | | for x in self{ [INFO] [stderr] 379 | | x.into_buffer(buf); [INFO] [stderr] 380 | | } [INFO] [stderr] 381 | | } [INFO] [stderr] | |_____^ [INFO] [stderr] [INFO] [stderr] warning: missing code example in this documentation [INFO] [stderr] --> src/lib.rs:383:5 [INFO] [stderr] | [INFO] [stderr] 383 | / fn copy_into_buffer(&self, buf: &mut Buffer){ [INFO] [stderr] 384 | | self.clone().into_buffer(buf); [INFO] [stderr] 385 | | } [INFO] [stderr] | |_____^ [INFO] [stderr] [INFO] [stderr] warning: missing code example in this documentation [INFO] [stderr] --> src/lib.rs:387:5 [INFO] [stderr] | [INFO] [stderr] 387 | / fn from_buffer(buf: &mut ReadBuffer) -> Option<Self>{ [INFO] [stderr] 388 | | let len = uworn!(u64::from_buffer(buf)); [INFO] [stderr] 389 | | let mut vec = Vec::new(); [INFO] [stderr] 390 | | for _ in 0..len{ [INFO] [stderr] ... | [INFO] [stderr] 394 | | Option::Some(vec) [INFO] [stderr] 395 | | } [INFO] [stderr] | |_____^ [INFO] [stderr] [INFO] [stderr] warning: missing code example in this documentation [INFO] [stderr] --> src/lib.rs:408:5 [INFO] [stderr] | [INFO] [stderr] 408 | / fn into_buffer(self, buf: &mut Buffer){ [INFO] [stderr] 409 | | self.0.into_buffer(buf); [INFO] [stderr] 410 | | self.1.into_buffer(buf); [INFO] [stderr] 411 | | } [INFO] [stderr] | |_____^ [INFO] [stderr] [INFO] [stderr] warning: missing code example in this documentation [INFO] [stderr] --> src/lib.rs:413:5 [INFO] [stderr] | [INFO] [stderr] 413 | / fn copy_into_buffer(&self, buf: &mut Buffer){ [INFO] [stderr] 414 | | self.clone().into_buffer(buf); [INFO] [stderr] 415 | | } [INFO] [stderr] | |_____^ [INFO] [stderr] [INFO] [stderr] warning: missing code example in this documentation [INFO] [stderr] --> src/lib.rs:417:5 [INFO] [stderr] | [INFO] [stderr] 417 | / fn from_buffer(buf: &mut ReadBuffer) -> Option<Self>{ [INFO] [stderr] 418 | | let x = uworn!(U::from_buffer(buf)); [INFO] [stderr] 419 | | let y = uworn!(V::from_buffer(buf)); [INFO] [stderr] 420 | | Option::Some((x,y)) [INFO] [stderr] 421 | | } [INFO] [stderr] | |_____^ [INFO] [stderr] [INFO] [stderr] warning: missing code example in this documentation [INFO] [stderr] --> src/lib.rs:435:5 [INFO] [stderr] | [INFO] [stderr] 435 | / fn into_buffer(self, buf: &mut Buffer){ [INFO] [stderr] 436 | | self.0.into_buffer(buf); [INFO] [stderr] 437 | | self.1.into_buffer(buf); [INFO] [stderr] 438 | | self.2.into_buffer(buf); [INFO] [stderr] 439 | | } [INFO] [stderr] | |_____^ [INFO] [stderr] [INFO] [stderr] warning: missing code example in this documentation [INFO] [stderr] --> src/lib.rs:441:5 [INFO] [stderr] | [INFO] [stderr] 441 | / fn copy_into_buffer(&self, buf: &mut Buffer){ [INFO] [stderr] 442 | | self.clone().into_buffer(buf); [INFO] [stderr] 443 | | } [INFO] [stderr] | |_____^ [INFO] [stderr] [INFO] [stderr] warning: missing code example in this documentation [INFO] [stderr] --> src/lib.rs:445:5 [INFO] [stderr] | [INFO] [stderr] 445 | / fn from_buffer(buf: &mut ReadBuffer) -> Option<Self>{ [INFO] [stderr] 446 | | let x = uworn!(U::from_buffer(buf)); [INFO] [stderr] 447 | | let y = uworn!(V::from_buffer(buf)); [INFO] [stderr] 448 | | let z = uworn!(W::from_buffer(buf)); [INFO] [stderr] 449 | | Option::Some((x,y,z)) [INFO] [stderr] 450 | | } [INFO] [stderr] | |_____^ [INFO] [stderr] [INFO] [stderr] Finished dev [unoptimized + debuginfo] target(s) in 1.08s [INFO] running `"docker" "inspect" "69aac8d5e1a7e9412418383833e63eb06675d93fccc2eabfc8cebd037ca3c892"` [INFO] running `"docker" "rm" "-f" "69aac8d5e1a7e9412418383833e63eb06675d93fccc2eabfc8cebd037ca3c892"` [INFO] [stdout] 69aac8d5e1a7e9412418383833e63eb06675d93fccc2eabfc8cebd037ca3c892