t

com.digitalasset.canton.version

HasVersionedToByteString

trait HasVersionedToByteString extends AnyRef

Trait for classes that can be serialized to a com.google.protobuf.ByteString. Typical use cases of toByteString include:

  • saving data in the database in serialized form (e.g. as in SequencedEvent)
  • encrypting data (e.g. as in Encryption.scala) *

In some exceptional cases, we also convert an object to a ByteString before including it in a Proto message (e.g. ViewCommonData or Envelope)

Classes that use Protobuf for serialization should implement HasVersionedWrapper instead. See "CONTRIBUTING.md" for our guidelines on serialization.

Linear Supertypes
AnyRef, Any
Known Subclasses
EncryptionPrivateKey, EncryptionPublicKey, Hash, Nonce, SecureRandomness, Signature, SigningPrivateKey, SigningPublicKey, SymmetricKey, CommonMetadata, FullInformeeTree, FullTransferInTree, FullTransferOutTree, GenTransferViewTree, InformeeTree, LightTransactionViewTree, MerkleSeqElement, ParticipantMetadata, SubmitterMetadata, TransactionView, TransferInCommonData, TransferInView, TransferInViewTree, TransferOutCommonData, TransferOutView, TransferOutViewTree, ViewCommonData, ViewParticipantData, DomainConnectionConfig, SubmissionTrackingData, TransactionSubmissionTrackingData, SerializableLedgerSyncEvent, ContractMetadata, RootHash, SerializableContract, SerializableRawContractInstance, StoredParties, TransactionId, AcsCommitment, EmptyRootHashMessagePayload, CompressedView, MalformedMediatorRequestResult, MediatorResponse, MediatorResult, RegularMediatorResult, RootHashMessagePayload, SerializedRootHashMessagePayload, SignedProtocolMessageContent, TransactionResultMessage, TransferResult, GrpcSequencerConnection, HttpSequencerConnection, SequencerConnection, AuthenticationToken, Deliver, DeliverError, SequencedEvent, SubmissionRequest, HasCryptographicEvidence, MemoizedEvidenceWithFailure, ProtocolVersionedMemoizedEvidence, TimeProof, StoredTopologyTransactions, DomainGovernanceTransaction, LegalIdentityClaim, SignedTopologyTransaction, TopologyStateUpdate, TopologyTransaction, TraceContext, HasVersionedWrapper
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HasVersionedToByteString
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def toByteString(version: ProtocolVersion): ByteString

    Returns the serialization of the object into a com.google.protobuf.ByteString.

    Returns the serialization of the object into a com.google.protobuf.ByteString. This method may yield different results if it is invoked several times.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped