pub struct File {
pub shebang: Option<String>,
pub attrs: Vec<Attribute>,
pub items: Vec<Item>,
}
Available on crate feature
full
only.Expand description
A complete file of Rust source code.
Typically File
objects are created with parse_file
.
§Example
Parse a Rust source file into a syn::File
and print out a debug
representation of the syntax tree.
use std::env;
use std::fs;
use std::process;
fn main() {
let mut args = env::args();
let _ = args.next(); // executable name
let filename = match (args.next(), args.next()) {
(Some(filename), None) => filename,
_ => {
eprintln!("Usage: dump-syntax path/to/filename.rs");
process::exit(1);
}
};
let src = fs::read_to_string(&filename).expect("unable to read file");
let syntax = syn::parse_file(&src).expect("unable to parse file");
// Debug impl is available if Syn is built with "extra-traits" feature.
println!("{:#?}", syntax);
}
Running with its own source code as input, this program prints output that begins with:
File {
shebang: None,
attrs: [],
items: [
Use(
ItemUse {
attrs: [],
vis: Inherited,
use_token: Use,
leading_colon: None,
tree: Path(
UsePath {
ident: Ident(
std,
),
colon2_token: Colon2,
tree: Name(
UseName {
ident: Ident(
env,
),
},
),
},
),
semi_token: Semi,
},
),
...
Fields§
§shebang: Option<String>
§attrs: Vec<Attribute>
§items: Vec<Item>
Trait Implementations§
Source§impl Parse for File
Available on crate feature parsing
only.
impl Parse for File
Available on crate feature
parsing
only.fn parse(input: ParseStream<'_>) -> Result<Self>
Source§impl ToTokens for File
Available on crate feature printing
only.
impl ToTokens for File
Available on crate feature
printing
only.Source§fn to_tokens(&self, tokens: &mut TokenStream)
fn to_tokens(&self, tokens: &mut TokenStream)
Source§fn to_token_stream(&self) -> TokenStream
fn to_token_stream(&self) -> TokenStream
Source§fn into_token_stream(self) -> TokenStreamwhere
Self: Sized,
fn into_token_stream(self) -> TokenStreamwhere
Self: Sized,
impl Eq for File
Available on crate feature
extra-traits
only.Auto Trait Implementations§
impl Freeze for File
impl RefUnwindSafe for File
impl !Send for File
impl !Sync for File
impl Unpin for File
impl UnwindSafe for File
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Spanned for Twhere
T: Spanned + ?Sized,
impl<T> Spanned for Twhere
T: Spanned + ?Sized,
Source§fn span(&self) -> Span
fn span(&self) -> Span
Available on crate features
parsing
and printing
only.Returns a
Span
covering the complete contents of this syntax tree
node, or Span::call_site()
if this node is empty.