alloy.proto
Members list
Type members
Classlikes
GRPC protocol as defined by https://grpc.io/
Attributes
- Companion
- class
- Supertypes
-
trait Producttrait Mirrortrait Companion[ProtoCompactUUID]trait Has[ProtoCompactUUID]trait ShapeTag[ProtoCompactUUID]trait HasIdclass Objecttrait Matchableclass AnyShow all
- Self type
-
ProtoCompactUUID.type
This trait can be used to enable protobuf conversion on services or structures that are not a part of a GRPC service.
Attributes
- Companion
- class
- Supertypes
-
trait Producttrait Mirrortrait Companion[ProtoEnabled]trait Has[ProtoEnabled]trait ShapeTag[ProtoEnabled]trait HasIdclass Objecttrait Matchableclass AnyShow all
- Self type
-
ProtoEnabled.type
Marks an explicit index to be used for a structure member when it is interpreted as protobuf. For example:
Marks an explicit index to be used for a structure member when it is interpreted as protobuf. For example:
structure Test { @protoIndex(2) str: String }
Is equivalent to:
message Test { string str = 2 }
Attributes
- Supertypes
- Self type
-
ProtoIndex.type
This trait can be used to customize the rendering of an Union shape during the conversion to Protobuf models. Union in Protobuf are typically encoded using oneOf.
This trait can be used to customize the rendering of an Union shape during the conversion to Protobuf models. Union in Protobuf are typically encoded using oneOf.
oneOf can only be used within message and each of their member has an index. This makes them tricky to render. One possible solution is to create a synthetic message to host the oneOf, and then use that message FQN at use site when refering to the Union. There is an alternate encoding where you render the oneOf inside the message where it's used. You can only use this encoding if the Union is used only inside of one structure.
You can use this trait, along with the validator provided, to implement this encoding.
Attributes
- Companion
- object
- Supertypes
Attributes
- Companion
- class
- Supertypes
-
trait Producttrait Mirrortrait Companion[ProtoInlinedOneOf]trait Has[ProtoInlinedOneOf]trait ShapeTag[ProtoInlinedOneOf]trait HasIdclass Objecttrait Matchableclass AnyShow all
- Self type
-
ProtoInlinedOneOf.type
Specifies which type of number signing should be used on integers and longs.
Specifies which type of number signing should be used on integers and longs.
Attributes
- Companion
- object
- Supertypes
- Known subtypes
Attributes
- Companion
- class
- Supertypes
-
trait Sumtrait Mirrortrait Enumeration[ProtoNumType]trait Companion[ProtoNumType]trait Has[ProtoNumType]trait ShapeTag[ProtoNumType]trait HasIdclass Objecttrait Matchableclass AnyShow all
- Self type
-
ProtoNumType.type
Marks certain field indexes as unusable by the smithy specification. For example, if a range is provided of 1 to 10 then the proto indexes for any fields in that structure must fall outside of that range. Ranges are inclusive.
Marks certain field indexes as unusable by the smithy specification. For example, if a range is provided of 1 to 10 then the proto indexes for any fields in that structure must fall outside of that range. Ranges are inclusive.
Attributes
- Supertypes
- Self type
-
ProtoReservedFields.type
Attributes
- Companion
- class
- Supertypes
-
trait Producttrait Mirrortrait Companion[ProtoWrapped]trait Has[ProtoWrapped]trait ShapeTag[ProtoWrapped]trait HasIdclass Objecttrait Matchableclass AnyShow all
- Self type
-
ProtoWrapped.type
Attributes
- Companion
- object
- Supertypes
- Known subtypes
- Self type
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrortrait Has[ReservedFieldsDefinition]trait ShapeTag[ReservedFieldsDefinition]trait HasIdclass Objecttrait Matchableclass AnyShow all
- Self type
Types
Marks an explicit index to be used for a structure member when it is interpreted as protobuf. For example:
Marks an explicit index to be used for a structure member when it is interpreted as protobuf. For example:
structure Test { @protoIndex(2) str: String }
Is equivalent to:
message Test { string str = 2 }
Attributes
Marks certain field indexes as unusable by the smithy specification. For example, if a range is provided of 1 to 10 then the proto indexes for any fields in that structure must fall outside of that range. Ranges are inclusive.
Marks certain field indexes as unusable by the smithy specification. For example, if a range is provided of 1 to 10 then the proto indexes for any fields in that structure must fall outside of that range. Ranges are inclusive.