asya/toml-rs
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Merge pull request #316 from pietroalbini/doc-spanned

Browse source 
Include Spanned in the docs
This commit is contained in:
Alex Crichton 2019-08-09 16:53:38 -05:00 committed by GitHub
parent 45361e70b9 c6745eeaeb
commit d410e2814f
2 changed files with 21 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
src/lib.rs
View file

@ -166,5 +166,4 @@ mod tokens;
pub mod macros;
mod spanned;
#[doc(no_inline)]
pub use crate::spanned::Spanned;

41
src/spanned.rs
View file

@ -1,23 +1,3 @@
//! ```
//! use serde_derive::Deserialize;
//! use toml::Spanned;
//!
//! #[derive(Deserialize)]
//! struct Value {
//! s: Spanned<String>,
//! }
//!
//! fn main() {
//! let t = "s = \"value\"\n";
//!
//! let u: Value = toml::from_str(t).unwrap();
//!
//! assert_eq!(u.s.start(), 4);
//! assert_eq!(u.s.end(), 11);
//! assert_eq!(u.s.get_ref(), "value");
//! assert_eq!(u.s.into_inner(), String::from("value"));
//! }
//! ```
use serde::{de, ser};
use std::fmt;
@ -32,6 +12,27 @@ pub const END: &'static str = "$__toml_private_end";
pub const VALUE: &'static str = "$__toml_private_value";
/// A spanned value, indicating the range at which it is defined in the source.
///
/// ```
/// use serde_derive::Deserialize;
/// use toml::Spanned;
///
/// #[derive(Deserialize)]
/// struct Value {
/// s: Spanned<String>,
/// }
///
/// fn main() {
/// let t = "s = \"value\"\n";
///
/// let u: Value = toml::from_str(t).unwrap();
///
/// assert_eq!(u.s.start(), 4);
/// assert_eq!(u.s.end(), 11);
/// assert_eq!(u.s.get_ref(), "value");
/// assert_eq!(u.s.into_inner(), String::from("value"));
/// }
/// ```
#[derive(Debug)]
pub struct Spanned<T> {
/// The start range.