Struct protobuf::descriptor::FileOptions

pub struct FileOptions {

    pub java_package: Option<String>,
    pub java_outer_classname: Option<String>,
    pub java_multiple_files: Option<bool>,
    pub java_generate_equals_and_hash: Option<bool>,
    pub java_string_check_utf8: Option<bool>,
    pub optimize_for: Option<EnumOrUnknown<OptimizeMode>>,
    pub go_package: Option<String>,
    pub cc_generic_services: Option<bool>,
    pub java_generic_services: Option<bool>,
    pub py_generic_services: Option<bool>,
    pub php_generic_services: Option<bool>,
    pub deprecated: Option<bool>,
    pub cc_enable_arenas: Option<bool>,
    pub objc_class_prefix: Option<String>,
    pub csharp_namespace: Option<String>,
    pub swift_prefix: Option<String>,
    pub php_class_prefix: Option<String>,
    pub php_namespace: Option<String>,
    pub php_metadata_namespace: Option<String>,
    pub ruby_package: Option<String>,
    pub uninterpreted_option: Vec<UninterpretedOption>,
    pub special_fields: SpecialFields,
}

Fields

java_package: Option<String>

Sets the Java package where classes generated from this .proto will be placed. By default, the proto package is used, but this is often inappropriate because proto packages do not normally start with backwards domain names.

java_outer_classname: Option<String>

Controls the name of the wrapper Java class generated for the .proto file. That class will always contain the .proto file’s getDescriptor() method as well as any top-level extensions defined in the .proto file. If java_multiple_files is disabled, then all the other classes from the .proto file will be nested inside the single wrapper outer class.

java_multiple_files: Option<bool>

If enabled, then the Java code generator will generate a separate .java file for each top-level message, enum, and service defined in the .proto file. Thus, these types will not be nested inside the wrapper class named by java_outer_classname. However, the wrapper class will still be generated to contain the file’s getDescriptor() method as well as any top-level extensions defined in the file.

java_generate_equals_and_hash: Option<bool>

This option does nothing.

java_string_check_utf8: Option<bool>

If set true, then the Java2 code generator will generate code that throws an exception whenever an attempt is made to assign a non-UTF-8 byte sequence to a string field. Message reflection will do the same. However, an extension field still accepts non-UTF-8 byte sequences. This option has no effect on when used with the lite runtime.

optimize_for: Option<EnumOrUnknown<OptimizeMode>>

go_package: Option<String>

Sets the Go package where structs generated from this .proto will be placed. If omitted, the Go package will be derived from the following:

• The basename of the package import path, if provided.
• Otherwise, the package statement in the .proto file, if present.
• Otherwise, the basename of the .proto file, without extension.

cc_generic_services: Option<bool>

Should generic services be generated in each language? “Generic” services are not specific to any particular RPC system. They are generated by the main code generators in each language (without additional plugins). Generic services were the only kind of service generation supported by early versions of google.protobuf.

Generic services are now considered deprecated in favor of using plugins that generate code specific to your particular RPC system. Therefore, these default to false. Old code which depends on generic services should explicitly set them to true.

java_generic_services: Option<bool>

py_generic_services: Option<bool>

php_generic_services: Option<bool>

deprecated: Option<bool>

Is this file deprecated? Depending on the target platform, this can emit Deprecated annotations for everything in the file, or it will be completely ignored; in the very least, this is a formalization for deprecating files.

cc_enable_arenas: Option<bool>

Enables the use of arenas for the proto messages in this file. This applies only to generated classes for C++.

objc_class_prefix: Option<String>

Sets the objective c class prefix which is prepended to all objective c generated classes from this .proto. There is no default.

csharp_namespace: Option<String>

Namespace for generated classes; defaults to the package.

swift_prefix: Option<String>

By default Swift generators will take the proto package and CamelCase it replacing ‘.’ with underscore and use that to prefix the types/symbols defined. When this options is provided, they will use this value instead to prefix the types/symbols defined.

php_class_prefix: Option<String>

Sets the php class prefix which is prepended to all php generated classes from this .proto. Default is empty.

php_namespace: Option<String>

Use this option to change the namespace of php generated classes. Default is empty. When this option is empty, the package name will be used for determining the namespace.

php_metadata_namespace: Option<String>

Use this option to change the namespace of php generated metadata classes. Default is empty. When this option is empty, the proto file name will be used for determining the namespace.

ruby_package: Option<String>

Use this option to change the package of ruby generated classes. Default is empty. When this option is not set, the package name will be used for determining the ruby package.

uninterpreted_option: Vec<UninterpretedOption>

The parser stores options it doesn’t recognize here. See the documentation for the “Options” section above.

special_fields: SpecialFields

Implementations

impl FileOptions

pub fn new() -> FileOptions

pub fn java_package(&self) -> &str

pub fn clear_java_package(&mut self)

pub fn has_java_package(&self) -> bool

pub fn set_java_package(&mut self, v: String)

pub fn mut_java_package(&mut self) -> &mut String

pub fn take_java_package(&mut self) -> String

pub fn java_outer_classname(&self) -> &str

pub fn clear_java_outer_classname(&mut self)

pub fn has_java_outer_classname(&self) -> bool

pub fn set_java_outer_classname(&mut self, v: String)

pub fn mut_java_outer_classname(&mut self) -> &mut String

pub fn take_java_outer_classname(&mut self) -> String

pub fn java_multiple_files(&self) -> bool

pub fn clear_java_multiple_files(&mut self)

pub fn has_java_multiple_files(&self) -> bool

pub fn set_java_multiple_files(&mut self, v: bool)

pub fn java_generate_equals_and_hash(&self) -> bool

pub fn clear_java_generate_equals_and_hash(&mut self)

pub fn has_java_generate_equals_and_hash(&self) -> bool

pub fn set_java_generate_equals_and_hash(&mut self, v: bool)

pub fn java_string_check_utf8(&self) -> bool

pub fn clear_java_string_check_utf8(&mut self)

pub fn has_java_string_check_utf8(&self) -> bool

pub fn set_java_string_check_utf8(&mut self, v: bool)

pub fn optimize_for(&self) -> OptimizeMode

pub fn clear_optimize_for(&mut self)

pub fn has_optimize_for(&self) -> bool

pub fn set_optimize_for(&mut self, v: OptimizeMode)

pub fn go_package(&self) -> &str

pub fn clear_go_package(&mut self)

pub fn has_go_package(&self) -> bool

pub fn set_go_package(&mut self, v: String)

pub fn mut_go_package(&mut self) -> &mut String

pub fn take_go_package(&mut self) -> String

pub fn cc_generic_services(&self) -> bool

pub fn clear_cc_generic_services(&mut self)

pub fn has_cc_generic_services(&self) -> bool

pub fn set_cc_generic_services(&mut self, v: bool)

pub fn java_generic_services(&self) -> bool

pub fn clear_java_generic_services(&mut self)

pub fn has_java_generic_services(&self) -> bool

pub fn set_java_generic_services(&mut self, v: bool)

pub fn py_generic_services(&self) -> bool

pub fn clear_py_generic_services(&mut self)

pub fn has_py_generic_services(&self) -> bool

pub fn set_py_generic_services(&mut self, v: bool)

pub fn php_generic_services(&self) -> bool

pub fn clear_php_generic_services(&mut self)

pub fn has_php_generic_services(&self) -> bool

pub fn set_php_generic_services(&mut self, v: bool)

pub fn deprecated(&self) -> bool

pub fn clear_deprecated(&mut self)

pub fn has_deprecated(&self) -> bool

pub fn set_deprecated(&mut self, v: bool)

pub fn cc_enable_arenas(&self) -> bool

pub fn clear_cc_enable_arenas(&mut self)

pub fn has_cc_enable_arenas(&self) -> bool

pub fn set_cc_enable_arenas(&mut self, v: bool)

pub fn objc_class_prefix(&self) -> &str

pub fn clear_objc_class_prefix(&mut self)

pub fn has_objc_class_prefix(&self) -> bool

pub fn set_objc_class_prefix(&mut self, v: String)

pub fn mut_objc_class_prefix(&mut self) -> &mut String

pub fn take_objc_class_prefix(&mut self) -> String

pub fn csharp_namespace(&self) -> &str

pub fn clear_csharp_namespace(&mut self)

pub fn has_csharp_namespace(&self) -> bool

pub fn set_csharp_namespace(&mut self, v: String)

pub fn mut_csharp_namespace(&mut self) -> &mut String

pub fn take_csharp_namespace(&mut self) -> String

pub fn swift_prefix(&self) -> &str

pub fn clear_swift_prefix(&mut self)

pub fn has_swift_prefix(&self) -> bool

pub fn set_swift_prefix(&mut self, v: String)

pub fn mut_swift_prefix(&mut self) -> &mut String

pub fn take_swift_prefix(&mut self) -> String

pub fn php_class_prefix(&self) -> &str

pub fn clear_php_class_prefix(&mut self)

pub fn has_php_class_prefix(&self) -> bool

pub fn set_php_class_prefix(&mut self, v: String)

pub fn mut_php_class_prefix(&mut self) -> &mut String

pub fn take_php_class_prefix(&mut self) -> String

pub fn php_namespace(&self) -> &str

pub fn clear_php_namespace(&mut self)

pub fn has_php_namespace(&self) -> bool

pub fn set_php_namespace(&mut self, v: String)

pub fn mut_php_namespace(&mut self) -> &mut String

pub fn take_php_namespace(&mut self) -> String

pub fn php_metadata_namespace(&self) -> &str

pub fn clear_php_metadata_namespace(&mut self)

pub fn has_php_metadata_namespace(&self) -> bool

pub fn set_php_metadata_namespace(&mut self, v: String)

pub fn mut_php_metadata_namespace(&mut self) -> &mut String

pub fn take_php_metadata_namespace(&mut self) -> String

pub fn ruby_package(&self) -> &str

pub fn clear_ruby_package(&mut self)

pub fn has_ruby_package(&self) -> bool

pub fn set_ruby_package(&mut self, v: String)

pub fn mut_ruby_package(&mut self) -> &mut String

pub fn take_ruby_package(&mut self) -> String

Trait Implementations

impl Clone for FileOptions

fn clone(&self) -> FileOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FileOptions

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

Formats the value using the given formatter.

impl Default for FileOptions

fn default() -> FileOptions

Returns the “default value” for a type.

impl<'a> Default for &'a FileOptions

fn default() -> &'a FileOptions

Returns the “default value” for a type.

impl Display for FileOptions

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

Formats the value using the given formatter.

impl Message for FileOptions

const NAME: &'static str = "FileOptions"

Message name as specified in .proto file.

fn is_initialized(&self) -> bool

True iff all required fields are initialized. Always returns true for protobuf 3.

fn merge_from(&mut self, is: &mut CodedInputStream<'_>) -> Result<()>

Update this message object with fields read from given stream.

fn compute_size(&self) -> u64

Compute and cache size of this message and all nested messages.

fn write_to_with_cached_sizes(
    &self,
    os: &mut CodedOutputStream<'_>
) -> Result<()>

Write message to the stream.

fn special_fields(&self) -> &SpecialFields

Special fields (unknown fields and cached size).

fn mut_special_fields(&mut self) -> &mut SpecialFields

Special fields (unknown fields and cached size).

fn new() -> FileOptions

Create an empty message object.

fn clear(&mut self)

Reset all fields.

fn default_instance() -> &'static FileOptions

Return a pointer to default immutable message with static lifetime.

fn parse_from(is: &mut CodedInputStream<'_>) -> Result<Self>

Parse message from stream.

fn cached_size(&self) -> u32

Get size previously computed by compute_size.

fn write_to(&self, os: &mut CodedOutputStream<'_>) -> Result<()>

Write the message to the stream.

fn write_length_delimited_to(
    &self,
    os: &mut CodedOutputStream<'_>
) -> Result<()>

Write the message to the stream prepending the message with message length encoded as varint.

fn write_length_delimited_to_vec(&self, vec: &mut Vec<u8>) -> Result<()>

Write the message to the vec, prepend the message with message length encoded as varint.

fn merge_from_bytes(&mut self, bytes: &[u8]) -> Result<()>

Update this message object with fields read from given stream.

fn parse_from_reader(reader: &mut dyn Read) -> Result<Self>

Parse message from reader. Parse stops on EOF or when error encountered.

fn parse_from_bytes(bytes: &[u8]) -> Result<Self>

Parse message from byte array.

fn parse_from_tokio_bytes(bytes: &Bytes) -> Result<Self>

Parse message from Bytes object. Resulting message may share references to the passed bytes object.

fn check_initialized(&self) -> Result<()>

Check if all required fields of this object are initialized.

fn write_to_writer(&self, w: &mut dyn Write) -> Result<()>

Write the message to the writer.

fn write_to_vec(&self, v: &mut Vec<u8>) -> Result<()>

Write the message to bytes vec.

fn write_to_bytes(&self) -> Result<Vec<u8>>

Write the message to bytes vec.

fn write_length_delimited_to_writer(&self, w: &mut dyn Write) -> Result<()>

Write the message to the writer, prepend the message with message length encoded as varint.

fn write_length_delimited_to_bytes(&self) -> Result<Vec<u8>>

Write the message to the bytes vec, prepend the message with message length encoded as varint.

fn unknown_fields(&self) -> &UnknownFields

Get a reference to unknown fields.

fn mut_unknown_fields(&mut self) -> &mut UnknownFields

Get a mutable reference to unknown fields.

impl MessageFull for FileOptions

fn descriptor() -> MessageDescriptor

Get message descriptor for message type.

fn reflect_eq(&self, other: &Self, mode: &ReflectEqMode) -> bool

Reflective equality.

impl PartialEq<FileOptions> for FileOptions

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl ProtobufValue for FileOptions

type RuntimeType = RuntimeTypeMessage<FileOptions>

Actual implementation of type properties.

fn runtime_type_box() -> RuntimeTypeBox

Dynamic version of the type.

fn as_ref(value: &Self) -> ReflectValueRef<'_>

Pointer to a dynamic reference.

fn as_mut(value: &mut Self) -> ReflectValueMut<'_>

Mutable pointer to a dynamic mutable reference.

fn from_value_box(value_box: ReflectValueBox) -> Result<Self, ReflectValueBox>

Construct a value from given reflective value.

fn set_from_value_box(target: &mut Self, value_box: ReflectValueBox)

Write the value.

fn default_value_ref() -> ReflectValueRef<'static>

Default value for this type.

fn into_static_value_ref(value: Self) -> ReflectValueRef<'static>

Convert a value into a ref value if possible.

fn is_non_zero(value: &Self) -> bool

Value is non-default?

fn cast_to_enum_values(values: &[Self]) -> &[i32]

Cast enum element data to integers.

impl StructuralPartialEq for FileOptions