types/number.proto

Table of Contents

• types/number.proto

  • FloatAttributes

  • FloatBounds

  • Int32Attributes

  • Int32Bounds

  • NumberCapping

  • InvalidNumberBehaviour

• Scalar Value Types

Top

types/number.proto

FloatAttributes

Describes features and restrictions applied to a number that is typically used as part of an apis value

Field	Type	Label	Description
bounds	FloatBounds
step	float		The stepping interval, how little the value can change in one go. A default value of 0 is equivalent to a continuous step, i.e. all possible float values are supported
supports_delta	bool		Indicate whether the device supports delta adjustments when changing the value
ramp_support	TweenSupport		Indicate the level of ramp support the device has
default_capping	NumberCapping		Provide information on how invalid values will be handled

FloatBounds

Defines the bounds for a number. Either of the min or max values can be absent which means those aspects are unbounded. It makes no sense for both to be unset, if so then this is no longer a bounds but that isn't disallowed.

Contrary to most programming practices both min and max are inclusive and denote the max allowed value, just like htmls input type=range.

Field	Type	Label	Description
min	float	optional	the minimum value (inclusive). If absent then there is no minimum, though this is typically Float.Min
max	float	optional	the maximum value (inclusive). If absent then there is no maximum, though this is typically Float.Max

Int32Attributes

Describes features and restrictions applied to a number that is typically used as part of an apis value

Field	Type	Label	Description
bounds	Int32Bounds
step	int32		The stepping interval, how little the value can change in one go. A default value of 0 is equivalent to a continuous step, i.e. step=1
supports_delta	bool		Indicate whether the device supports delta adjustments when changing the value
ramp_support	TweenSupport		Indicate the level of ramp support the device has
default_capping	NumberCapping		Provide information on how invalid values will be handled

Int32Bounds

Defines the bounds for a number. Either of the min or max values can be absent which means those aspects are unbounded. It makes no sense for both to be unset, if so then this is no longer a bounds but that isn't disallowed.

Contrary to most programming practices both min and max are inclusive and denote the max allowed value, just like htmls input type=range.

Field	Type	Label	Description
min	int32	optional	the minimum value (inclusive). If absent then there is no minimum, though this is typically Int32.Min
max	int32	optional	the maximum value (inclusive). If absent then there is no maximum, though this is typically Int32.Max

NumberCapping

Options for how invalid number values will be handled

Field	Type	Label	Description
min	InvalidNumberBehaviour		If the value is less than the minimum, behave this way. Should default to RESTRICT
step	InvalidNumberBehaviour		If the value does not lie on a step value, behave this way. Should default to ALLOW
max	InvalidNumberBehaviour		If the value is greater than the maximum, behave this way. Should default to RESTRICT

InvalidNumberBehaviour

Possible behaviours for values that are not allowed by the number

Name	Number	Description
INVALID_NUMBER_BEHAVIOUR_UNSPECIFIED	0	A default behaviour will be applied, typically RESTRICT
RESTRICT	1	The value will be restricted to the most appropriate value, typically the closest
ERROR	2	An error will be raised to alert to the invalid value
ALLOW	3	Ignore the bounds and apply the value anyway

Scalar Value Types

.proto Type	Notes	C++	Java	Python	Go	C#	PHP	Ruby
double		double	double	float	float64	double	float	Float
float		float	float	float	float32	float	float	Float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long	int64	long	integer/string	Bignum
uint32	Uses variable-length encoding.	uint32	int	int/long	uint32	uint	integer	Bignum or Fixnum (as required)
uint64	Uses variable-length encoding.	uint64	long	int/long	uint64	ulong	integer/string	Bignum or Fixnum (as required)
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long	int64	long	integer/string	Bignum
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int	uint32	uint	integer	Bignum or Fixnum (as required)
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long	uint64	ulong	integer/string	Bignum
sfixed32	Always four bytes.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sfixed64	Always eight bytes.	int64	long	int/long	int64	long	integer/string	Bignum
bool		bool	boolean	boolean	bool	bool	boolean	TrueClass/FalseClass
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode	string	string	string	String (UTF-8)
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str	[]byte	ByteString	string	String (ASCII-8BIT)