Struct File

pub struct File {
    pub shebang: Option<String>,
    pub attrs: Vec<Attribute>,
    pub items: Vec<Item>,
}

A complete file of Rust source code.

This type is available if Syn is built with the "full" feature.

Example

Parse a Rust source file into a syn::File and print out a debug representation of the syntax tree.

extern crate syn;

use std::env;
use std::fs::File;
use std::io::Read;
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 mut file = File::open(&filename).expect("Unable to open file");

    let mut src = String::new();
    file.read_to_string(&mut src).expect("Unable to read file");

    let syntax = syn::parse_file(&src).expect("Unable to parse file");
    println!("{:#?}", syntax);
}

Running with its own source code as input, this program prints output that begins with:

File {
    shebang: None,
    attrs: [],
    items: [
        ExternCrate(
            ItemExternCrate {
                attrs: [],
                vis: Inherited,
                extern_token: Extern,
                crate_token: Crate,
                ident: Ident {
                    term: Term(
                        "syn"
                    ),
                    span: Span
                },
                rename: None,
                semi_token: Semi
            }
        ),
...

Fields

shebang: Option<String>

attrs: Vec<Attribute>

items: Vec<Item>

Trait Implementations

impl Clone for File

fn clone(&self) -> File

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for File

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for File

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for File

fn eq(&self, other: &File) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Synom for File

fn parse(i: Cursor<'_>) -> PResult<'_, Self>

fn description() -> Option<&'static str>

impl ToTokens for File

fn to_tokens(&self, tokens: &mut Tokens)

Write self to the given Tokens.

fn into_tokens(self) -> Tokens

where Self: Sized,

Convert self directly into a Tokens object.

impl Eq for File

impl StructuralPartialEq for File