Skip to content

Ruby: adds documentation for message repeated fields #183

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Ruby: adds documentation for message repeated fields #183

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6f1864e
Adds documentation for message repeated fields
jsilland Sep 5, 2024
99b14af
Update ruby-generated.md
jsilland Sep 6, 2024
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
16 changes: 16 additions & 0 deletions content/reference/ruby/ruby-generated.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,6 +274,22 @@ int_repeatedfield.clear
raise unless int_repeatedfield.empty?
```

For repeated fields that contain messages, the constructor for
`Google::Protobuf::RepeatedField` supports a variant with three arguments:
`:message`, the class of the submessage, and the values to set:

```ruby
first_message = MySubMessage.new(:foo => 42)
second_message = MySubMessage.new(:foo => 79)

repeated_field = Google::Protobuf::RepeatedField.new(
:message,
MySubMessage,
[first_message, second_message]
)
message.sub_message_repeated_field = repeated_field
```

The `RepeatedField` type supports all of the same methods as a regular Ruby
`Array`. You can convert it to a regular Ruby Array with `repeated_field.to_a`.

Expand Down