Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions cobertura.xml

Large diffs are not rendered by default.

7 changes: 7 additions & 0 deletions prost-reflect/src/descriptor/api.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1075,6 +1075,13 @@ impl FieldDescriptor {
self.inner().is_packed
}

/// Whether this field is required.
///
/// For proto3 this always returns `false`.
pub fn is_required(&self) -> bool {
self.cardinality() == Cardinality::Required
}

/// The cardinality of this field.
pub fn cardinality(&self) -> Cardinality {
self.inner().cardinality
Expand Down
87 changes: 87 additions & 0 deletions prost-reflect/src/descriptor/tests.rs
Original file line number Diff line number Diff line change
Expand Up @@ -504,3 +504,90 @@ fn error_source_location() {
"myfile.proto:2:9: name 'my.package.Foo' is defined twice"
);
}

#[test]
fn field_is_required_proto2() {
let file_descriptor_set = FileDescriptorSet {
file: vec![FileDescriptorProto {
name: Some("myfile.proto".to_owned()),
package: Some("my.package".to_owned()),
syntax: Some("proto2".to_owned()),
message_type: vec![DescriptorProto {
name: Some("MyMessage".to_owned()),
field: vec![
FieldDescriptorProto {
name: Some("required_field".to_owned()),
number: Some(1),
label: Some(Label::Required as i32),
r#type: Some(Type::String as i32),
..Default::default()
},
FieldDescriptorProto {
name: Some("optional_field".to_owned()),
number: Some(2),
label: Some(Label::Optional as i32),
r#type: Some(Type::String as i32),
..Default::default()
},
],
..Default::default()
}],
..Default::default()
}],
};

let descriptor_pool = DescriptorPool::from_file_descriptor_set(file_descriptor_set).unwrap();
let message = descriptor_pool
.get_message_by_name("my.package.MyMessage")
.unwrap();

let required_field = message.get_field_by_name("required_field").unwrap();
let optional_field = message.get_field_by_name("optional_field").unwrap();

assert!(required_field.is_required());
assert!(!optional_field.is_required());
}

#[test]
fn field_is_required_proto3() {
let file_descriptor_set = FileDescriptorSet {
file: vec![FileDescriptorProto {
name: Some("myfile.proto".to_owned()),
package: Some("my.package".to_owned()),
syntax: Some("proto3".to_owned()),
message_type: vec![DescriptorProto {
name: Some("MyMessage".to_owned()),
field: vec![
FieldDescriptorProto {
name: Some("optional_field".to_owned()),
number: Some(1),
label: Some(Label::Optional as i32),
r#type: Some(Type::String as i32),
..Default::default()
},
FieldDescriptorProto {
name: Some("repeated_field".to_owned()),
number: Some(2),
label: Some(Label::Repeated as i32),
r#type: Some(Type::String as i32),
..Default::default()
},
],
..Default::default()
}],
..Default::default()
}],
};

let descriptor_pool = DescriptorPool::from_file_descriptor_set(file_descriptor_set).unwrap();
let message = descriptor_pool
.get_message_by_name("my.package.MyMessage")
.unwrap();

let optional_field = message.get_field_by_name("optional_field").unwrap();
let repeated_field = message.get_field_by_name("repeated_field").unwrap();

// In proto3, there are no required fields
assert!(!optional_field.is_required());
assert!(!repeated_field.is_required());
}