Skip to content

Commit

Permalink
v1.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
guzba committed Oct 17, 2020
1 parent 6b0144a commit e8a390c
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,44 +74,44 @@ This implementation was heavily influenced by [snappy-c](https://github.com/andi
import supersnappy
```

## **type** SnappyException
## **type** SnappyError

Raised if an operation fails.

```nim
SnappyException = object of ValueError
SnappyError = object of ValueError
```

## **func** uncompress

Uncompresses src into dst. This resizes dst as needed and starts writing at dst index 0.

```nim
func uncompress(src: openArray[uint8]; dst: var seq[uint8]) {.raises: [SnappyException].}
func uncompress(src: openArray[uint8]; dst: var seq[uint8]) {.raises: [SnappyError].}
```

## **func** uncompress

Uncompresses src and returns the uncompressed data seq.

```nim
func uncompress(src: openArray[uint8]): seq[uint8] {.inline, raises: [SnappyException].}
func uncompress(src: openArray[uint8]): seq[uint8] {.inline, raises: [SnappyError].}
```

## **func** compress

Compresses src into dst. This resizes dst as needed and starts writing at dst index 0.

```nim
func compress(src: openArray[uint8]; dst: var seq[uint8]) {.raises: [SnappyException], tags: [].}
func compress(src: openArray[uint8]; dst: var seq[uint8]) {.raises: [SnappyError].}
```

## **func** compress

Compresses src and returns the compressed data seq.

```nim
func compress(src: openArray[uint8]): seq[uint8] {.inline, raises: [SnappyException], tags: [].}
func compress(src: openArray[uint8]): seq[uint8] {.inline, raises: [SnappyError].}
```

## **template** uncompress
Expand Down
2 changes: 1 addition & 1 deletion supersnappy.nimble
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
packageName = "supersnappy"
version = "1.0.0"
version = "1.1.0"
author = "Ryan Oldenburg"
description = "Nim implementation of Google's Snappy compression."
license = "MIT"
Expand Down

0 comments on commit e8a390c

Please sign in to comment.