# Struct syn::File

source · [−]

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

Expand description

A complete file of Rust source code.

This type is available only 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.

    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");

        // 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 Clone for File

source

#### fn clone(&self) -> Self

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from `source`. Read more

source

### impl Parse for File

source

#### fn parse(input: ParseStream<'_>) -> Result<Self>

source

### impl ToTokens for File

source

#### fn to_tokens(&self, tokens: &mut TokenStream)

Write `self` to the given `TokenStream`. Read more

source

#### fn to_token_stream(&self) -> TokenStream

Convert `self` directly into a `TokenStream` object. Read more

source

#### fn into_token_stream(self) -> TokenStream

Convert `self` directly into a `TokenStream` object. Read more

## Auto Trait Implementations

### 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> Any for T where
T: 'static + ?Sized,

source

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more

source

### impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

### impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

### impl<T> From<T> for T

const: unstable · source

#### fn from(t: T) -> T

Returns the argument unchanged.

source

### impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

source

### impl<T> Spanned for T where
T: Spanned + ?Sized,

source

#### fn span(&self) -> Span

Returns a `Span` covering the complete contents of this syntax tree node, or `Span::call_site()` if this node is empty. Read more

source

### impl<T> ToOwned for T where
T: Clone,

#### type Owned = T

The resulting type after obtaining ownership.

source

#### fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

#### fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

### impl<T, U> TryFrom<U> for T where
U: Into<T>,

#### type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

source

### impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.