Struct File

pub struct File { /* private fields */ }

An opened protobuf source file, returned by FileResolver::open_file.

Implementations

impl File

pub fn open(name: &str, path: &Path) -> Result<Self, Error>

Read a protobuf source file from the filesystem into a new instance of File

Errors

Returns an error if there is an IO error opening the file, or it is not a valid protobuf source file.

If the file does not exist, Error::file_not_found() is returned

Examples

fs::write("foo.proto", "message Foo { }").unwrap();

let file = File::open("foo.proto", "foo.proto".as_ref()).unwrap();
assert_eq!(file.path(), Some("foo.proto".as_ref()));
assert_eq!(file.source(), Some("message Foo { }"));
assert_eq!(file.file_descriptor_proto(), &FileDescriptorProto {
    name: Some("foo.proto".to_owned()),
    message_type: vec![DescriptorProto {
        name: Some("Foo".to_owned()),
        ..Default::default()
    }],
    source_code_info: Some(SourceCodeInfo {
        location: vec![
            Location { path: vec![], span: vec![0, 0, 15], ..Default::default() },
            Location { path: vec![4, 0], span: vec![0, 0, 15], ..Default::default() },
            Location { path: vec![4, 0, 1], span: vec![0, 8, 11], ..Default::default() }
        ]
    }),
    ..Default::default()
});

assert!(File::open("notfound.proto", "notfound.proto".as_ref()).unwrap_err().is_file_not_found());

pub fn from_source(name: &str, source: &str) -> Result<Self, Error>

Read a protobuf source file from a string into a new instance of File

Errors

Returns an error the string is not a valid protobuf source file.

Examples

let file = File::from_source("foo.proto", "message Foo { }").unwrap();
assert_eq!(file.path(), None);
assert_eq!(file.source(), Some("message Foo { }"));
assert_eq!(file.file_descriptor_proto(), &FileDescriptorProto {
    name: Some("foo.proto".to_owned()),
    message_type: vec![DescriptorProto {
        name: Some("Foo".to_owned()),
        ..Default::default()
    }],
    source_code_info: Some(SourceCodeInfo {
        location: vec![
            Location { path: vec![], span: vec![0, 0, 15], ..Default::default() },
            Location { path: vec![4, 0], span: vec![0, 0, 15], ..Default::default() },
            Location { path: vec![4, 0, 1], span: vec![0, 8, 11], ..Default::default() }
        ]
    }),
    ..Default::default()
});

pub fn from_file_descriptor_proto(file: FileDescriptorProto) -> Self

Create a new instance of File from a parsed FileDescriptorProto.

The file does not need to have type names or imports resolved. Typically, it would be returned by the parse() method.

pub fn decode_file_descriptor_proto<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf,

Create an instance of File by deserializing a FileDescriptorProto from the given bytes.

Unlike when going through from_file_descriptor_proto(), extension options are preserved.

The file does not need to have type names or imports resolved.

pub fn name(&self) -> &str

Returns the name of this file.

pub fn path(&self) -> Option<&Path>

Returns the filesystem path, if this source is backed by a physical file.

pub fn source(&self) -> Option<&str>

Returns the full content of the source file if available.

pub fn file_descriptor_proto(&self) -> &FileDescriptorProto

Returns the parsed value of the source file.

This is typically equivalent to calling parse() on the string returned by source().

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 From<File> for FileDescriptorProto

fn from(file: File) -> Self

Converts to this type from the input type.

impl From<FileDescriptorProto> for File

fn from(file: FileDescriptorProto) -> Self

Converts to this type from the input type.