scalapb.validate.validate

Members list

Type members

Classlikes

final case class Dummy(dummy: Option[FieldRules], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[Dummy]

Attributes

Companion
object
Supertypes
trait Updatable[Dummy]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Dummy extends GeneratedMessageCompanion[Dummy], JavaProtoSupport[Dummy, Dummy]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait JavaProtoSupport[Dummy, Dummy]
trait GeneratedMessageCompanion[Dummy]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Dummy.type
final case class FieldValidationOptions(skipUniqueCheck: Option[Boolean], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[FieldValidationOptions]

Value parameters

skipUniqueCheck

not implemented yet

Attributes

Companion
object
Supertypes
trait Updatable[FieldValidationOptions]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object FieldValidationOptions extends GeneratedMessageCompanion[FieldValidationOptions], JavaProtoSupport[FieldValidationOptions, FieldValidationOptions]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait JavaProtoSupport[FieldValidationOptions, FieldValidationOptions]
trait GeneratedMessageCompanion[FieldValidationOptions]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class FileValidationOptions(insertValidatorInstance: Option[Boolean], validateAtConstruction: Option[Boolean], uniqueToSet: Option[Boolean], catsTransforms: Option[Boolean], skip: Option[Boolean], skipPackages: Seq[String], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[FileValidationOptions]

Value parameters

catsTransforms

transform to non-empty map, list and set.

skip

Set skip to true to avoid generating validators for this file. This option is also useful to be set a package-scoped option for third-party protos that do not come with validator classes and your messages reference them.

skipPackages

List of packages that are known to not have validators generated for them. Same effect as setting skip to true for all files in the package. This is useful when package-scoped options for that third-party package are already defined.

uniqueToSet

The following options inject field transformations in the proto they are defined on. In order to take effect, scalapb-validate's preprocessor need to be enabled in the same file where these options are set. Example: import "scalapb/validate.proto"; import "scalapb/scalapb.proto"; option (scalapb.options) = { scope : PACKAGE // makes the FieldTransformations available for the entire package preprocessors : [ "scalapb-validate-preprocessor" ] [scalapb.validate.file] { cats_transforms : true unique_to_set : true } } transform "repeated.unique: true" to sets.

Attributes

Companion
object
Supertypes
trait Updatable[FileValidationOptions]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object FileValidationOptions extends GeneratedMessageCompanion[FileValidationOptions], JavaProtoSupport[FileValidationOptions, FileValidationOptions]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait JavaProtoSupport[FileValidationOptions, FileValidationOptions]
trait GeneratedMessageCompanion[FileValidationOptions]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class MessageValidationOptions(insertValidatorInstance: Option[Boolean], validateAtConstruction: Option[Boolean], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[MessageValidationOptions]

Falls back on file validation options (where default exists)

Falls back on file validation options (where default exists)

Attributes

Companion
object
Supertypes
trait Updatable[MessageValidationOptions]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object MessageValidationOptions extends GeneratedMessageCompanion[MessageValidationOptions], JavaProtoSupport[MessageValidationOptions, MessageValidationOptions]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait JavaProtoSupport[MessageValidationOptions, MessageValidationOptions]
trait GeneratedMessageCompanion[MessageValidationOptions]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
object ValidateProto extends GeneratedFileObject

Attributes

Supertypes
class GeneratedFileObject
class Object
trait Matchable
class Any
Self type