https://github.com/ballerina-platform/module-ballerina-serdes
This is the Ballerina SerDes package, which is a part of the Ballerina Language Standard Library
https://github.com/ballerina-platform/module-ballerina-serdes
ballerina serdes standard-library
Last synced: about 2 months ago
JSON representation
This is the Ballerina SerDes package, which is a part of the Ballerina Language Standard Library
- Host: GitHub
- URL: https://github.com/ballerina-platform/module-ballerina-serdes
- Owner: ballerina-platform
- License: apache-2.0
- Created: 2021-04-01T09:56:13.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-07-14T08:22:09.000Z (over 2 years ago)
- Last Synced: 2024-04-18T02:38:35.693Z (over 1 year ago)
- Topics: ballerina, serdes, standard-library
- Language: Java
- Homepage: https://ballerina.io/
- Size: 41.5 MB
- Stars: 115
- Watchers: 68
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
Ballerina SerDes Library
===================
[](https://github.com/ballerina-platform/module-ballerina-serdes/actions?query=workflow%3ABuild)
[](https://codecov.io/gh/ballerina-platform/module-ballerina-serdes)
[](https://github.com/ballerina-platform/module-ballerina-serdes/actions/workflows/trivy-scan.yml)
[](https://github.com/ballerina-platform/module-ballerina-serdes/actions/workflows/build-with-bal-test-native.yml)
[](https://github.com/ballerina-platform/module-ballerina-serdes/commits/main)
[](https://github.com/ballerina-platform/ballerina-standard-library/labels/module%2Fserdes)
>**Deprecation Notice:** This library is deprecated and will no longer be maintained or updated.
This library provides APIs for serializing and deserializing subtypes of Ballerina anydata type.
### Proto3Schema
An instance of the `serdes:Proto3Schema` class is used to serialize and deserialize ballerina values using protocol buffers.
#### Create a `serdes:Proto3Schema` object
```ballerina
// Define a type which is a subtype of anydata.
type Student record {
int id;
string name;
decimal fees;
};
// Create a schema object by passing the type.
serdes:Proto3Schema schema = check new (Student);
```
While instantiation of this object, an underlying proto3 schema generated for the provided typedesc.
#### Serialization
```ballerina
Student student = {
id: 7894,
name: "Liam",
fees: 24999.99
};
// Serialize the record value to bytes.
byte[] bytes = check schema.serialize(student);
```
A value having the same type as the provided type can be serialized by invoking the `serialize` method on the previously instantiated `serdes:Proto3Schema` object. The underlying implementation uses the previously generated proto3 schema to serialize the provided value.
#### Deserialization
```ballerina
type Student record {
int id;
string name;
decimal fees;
};
byte[] bytes = readSerializedDataToByteArray();
serdes:Proto3Schema schema = check new (Student);
// Deserialize the record value from bytes.
Student student = check schema.deserialize(bytes);
```
The serialized value (`byte[]`) can be again deserialized by invoking the `deserialize` method on the instantiated `serdes:Proto3Schema` object. The underlying implementation uses the previously generated proto3 schema and deserializes the provided `byte[]`. As the result of deserialization the method returns the ballerina value with the type represented by the typedesc value provided during the `serdes:Proto3Schema` object instantiation.
## Issues and Projects
The **Issues** and **Projects** tabs are disabled for this repository as this is part of the Ballerina Standard Library. To report bugs, request new features, start new discussions, view project boards, etc., go to the Ballerina Standard Library [parent repository](https://github.com/ballerina-platform/ballerina-standard-library).
This repository contains only the source code of the package.
## Building from the Source
### Setting Up the Prerequisites
1. Download and install Java SE Development Kit (JDK) version 11 (from one of the following locations).
* [Oracle](https://www.oracle.com/java/technologies/javase-jdk11-downloads.html)
* [OpenJDK](https://adoptium.net/)
> **Note:** Set the JAVA_HOME environment variable to the path name of the directory into which you installed JDK.
2. Export your Github Personal access token with the read package permissions as follows.
export packageUser=
export packagePAT=
### Building the Source
Execute the commands below to build from source.
1. To build the package:
./gradlew clean build
2. To run the integration tests:
./gradlew clean test
3. To build the package without the tests:
./gradlew clean build -x test
4. To debug the tests:
./gradlew clean build -Pdebug=
## Contributing to Ballerina
As an open source project, Ballerina welcomes contributions from the community.
For more information, go to the [contribution guidelines](https://github.com/ballerina-platform/ballerina-lang/blob/master/CONTRIBUTING.md).
## Code of Conduct
All contributors are encouraged to read the [Ballerina Code of Conduct](https://ballerina.io/code-of-conduct).
## Useful Links
* Discuss about code changes of the Ballerina project in [ballerina-dev@googlegroups.com](mailto:ballerina-dev@googlegroups.com).
* Chat live with us via our [Discord server](https://discord.gg/ballerinalang).
* Post all technical questions on Stack Overflow with the [#ballerina](https://stackoverflow.com/questions/tagged/ballerina) tag.