Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/guardian/thrift-serializer
Serialize thrift models into bytes
https://github.com/guardian/thrift-serializer
misc production
Last synced: about 2 months ago
JSON representation
Serialize thrift models into bytes
- Host: GitHub
- URL: https://github.com/guardian/thrift-serializer
- Owner: guardian
- License: other
- Created: 2016-02-01T15:13:26.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-07-29T08:59:40.000Z (2 months ago)
- Last Synced: 2024-07-29T12:12:39.510Z (2 months ago)
- Topics: misc, production
- Language: Scala
- Homepage:
- Size: 183 KB
- Stars: 3
- Watchers: 41
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Thrift Serializer [](https://github.com/guardian/thrift-serializer/actions/workflows/release.yml)
========
_A library for serializing a thrift model into bytes._
[](https://index.scala-lang.org/guardian/thrift-serializer/thrift-serializer)
### How to use
* Add the library as a depency by adding
```
"com.gu" %% "thrift-serializer" % "2.1.1"
```
to your applications libraryDepencies.
* You can then use ThriftSerializer in your application:
```
import com.gu.thrift.serializer.ThriftSerializer
object myObject extends ThriftSerializer {
def myMethod(thriftObject: MyThriftObject): Unit = {
val bytes = serializeToBytes(thriftObject)
//Do something with bytes
}
}
```
* You can use the ThriftDeserializer like this:
```
MyDeserializer.deserialize(buffer).map(myEvent => {
// process the event
}
def myMethod(thriftObject: MyThriftObject): Unit = {
val bytes = serializeToBytes(thriftObject)
//Do something with bytes
}
```
If there is no compression type recorded in the bytes you wish to
deserialize or if you don't want these to be included when serializing
a thrift object, you can set the last arguments of the function calls
to true. They are false by default.
```
MyDeserializer.deserialize(buffer, true).map(myEvent => {
// process the event
}
```
```
def myMethod(thriftObject: MyThriftObject, true): Unit = {
val bytes = serializeToBytes(thriftObject)
//Do something with bytes
}
```
### Node JS
* Install using npm
```
npm install --save thrift-serializer
```
in your application or lambda you can **decode** messages
```
var Message = require('your-thrift-model');
var serializer = require('thrift-serializer');
serializer.read(Message, bytes, function (err, msg) {
console.log(msg);
});
```
or **encode** them
```
var Message = require('your-thrift-model');
var serializer = require('thrift-serializer');
var message = new Message({
someData: ''
});
serializer.write(message, serializer.Compression.Gzip, function (err, bytes) {
// do something with your bytes, e.g. convert the buffer into a base64 string
console.log(bytes.toString('base64'));
});
```
## How to make releases (Maven Central):
This repo uses [`gha-scala-library-release-workflow`](https://github.com/guardian/gha-scala-library-release-workflow)
to automate publishing releases (both full & preview releases) - see
[**Making a Release**](https://github.com/guardian/gha-scala-library-release-workflow/blob/main/docs/making-a-release.md).