Documentation
¶
Index ¶
- Variables
- type Viewport
- func (m *Viewport) CloneMessageVT() proto.Message
- func (m *Viewport) CloneVT() *Viewport
- func (*Viewport) Descriptor() ([]byte, []int)deprecated
- func (this *Viewport) EqualMessageVT(thatMsg proto.Message) bool
- func (this *Viewport) EqualVT(that *Viewport) bool
- func (x *Viewport) GetHigh() *_type.LatLng
- func (x *Viewport) GetLow() *_type.LatLng
- func (m *Viewport) MarshalToSizedBufferVT(dAtA []byte) (int, error)
- func (m *Viewport) MarshalToVT(dAtA []byte) (int, error)
- func (m *Viewport) MarshalVT() (dAtA []byte, err error)
- func (*Viewport) ProtoMessage()
- func (x *Viewport) ProtoReflect() protoreflect.Message
- func (x *Viewport) Reset()
- func (m *Viewport) SizeVT() (n int)
- func (x *Viewport) String() string
- func (m *Viewport) UnmarshalVT(dAtA []byte) error
- func (m *Viewport) Validate() error
- func (m *Viewport) ValidateAll() error
- type ViewportMultiError
- type ViewportValidationError
Constants ¶
This section is empty.
Variables ¶
var File_google_geo_type_viewport_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type Viewport ¶
type Viewport struct {
// Required. The low point of the viewport.
Low *_type.LatLng `protobuf:"bytes,1,opt,name=low,proto3" json:"low,omitempty"`
// Required. The high point of the viewport.
High *_type.LatLng `protobuf:"bytes,2,opt,name=high,proto3" json:"high,omitempty"`
// contains filtered or unexported fields
}
A latitude-longitude viewport, represented as two diagonally opposite `low` and `high` points. A viewport is considered a closed region, i.e. it includes its boundary. The latitude bounds must range between -90 to 90 degrees inclusive, and the longitude bounds must range between -180 to 180 degrees inclusive. Various cases include:
If `low` = `high`, the viewport consists of that single point.
If `low.longitude` > `high.longitude`, the longitude range is inverted (the viewport crosses the 180 degree longitude line).
If `low.longitude` = -180 degrees and `high.longitude` = 180 degrees, the viewport includes all longitudes.
If `low.longitude` = 180 degrees and `high.longitude` = -180 degrees, the longitude range is empty.
If `low.latitude` > `high.latitude`, the latitude range is empty.
Both `low` and `high` must be populated, and the represented box cannot be empty (as specified by the definitions above). An empty viewport will result in an error.
For example, this viewport fully encloses New York City:
{
"low": {
"latitude": 40.477398,
"longitude": -74.259087
},
"high": {
"latitude": 40.91618,
"longitude": -73.70018
}
}
func (*Viewport) CloneMessageVT ¶
func (*Viewport) Descriptor
deprecated
func (*Viewport) MarshalToSizedBufferVT ¶
func (*Viewport) ProtoMessage ¶
func (*Viewport) ProtoMessage()
func (*Viewport) ProtoReflect ¶
func (x *Viewport) ProtoReflect() protoreflect.Message
func (*Viewport) UnmarshalVT ¶
func (*Viewport) Validate ¶
Validate checks the field values on Viewport with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.
func (*Viewport) ValidateAll ¶
ValidateAll checks the field values on Viewport with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in ViewportMultiError, or nil if none found.
type ViewportMultiError ¶
type ViewportMultiError []error
ViewportMultiError is an error wrapping multiple validation errors returned by Viewport.ValidateAll() if the designated constraints aren't met.
func (ViewportMultiError) AllErrors ¶
func (m ViewportMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (ViewportMultiError) Error ¶
func (m ViewportMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type ViewportValidationError ¶
type ViewportValidationError struct {
// contains filtered or unexported fields
}
ViewportValidationError is the validation error returned by Viewport.Validate if the designated constraints aren't met.
func (ViewportValidationError) Cause ¶
func (e ViewportValidationError) Cause() error
Cause function returns cause value.
func (ViewportValidationError) Error ¶
func (e ViewportValidationError) Error() string
Error satisfies the builtin error interface
func (ViewportValidationError) ErrorName ¶
func (e ViewportValidationError) ErrorName() string
ErrorName returns error name.
func (ViewportValidationError) Field ¶
func (e ViewportValidationError) Field() string
Field function returns field value.
func (ViewportValidationError) Key ¶
func (e ViewportValidationError) Key() bool
Key function returns key value.
func (ViewportValidationError) Reason ¶
func (e ViewportValidationError) Reason() string
Reason function returns reason value.
Source Files