Skip to content

Commit 207dde5

Browse files
thomasnemersnej
thomasnemer
and
snej
authored
Forking and signing upstream 39d58b5 (#1)
Initial checkin: Updated for CBL-C beta Enabled static linking with CBL (super-experimental) This only works on macOS so far. It requires you to have a checkout of `couchbase-lite-c`, and to have built it with CMake, AND you have to manually postprocess its static libs with `lipo` to work around a Rust linker bug. :-p Minor README fixes Create LICENSE Co-authored-by: Jens Alfke <jens@couchbase.com>
1 parent defc953 commit 207dde5

23 files changed

+3878
-2
lines changed

‎.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
/target/
2+
Cargo.lock

‎Cargo.toml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
[package]
2+
name = "couchbase_lite"
3+
version = "0.2.0"
4+
5+
[dependencies]
6+
enum_primitive = "*"
7+
tempdir = "*"
8+
9+
[build-dependencies]
10+
bindgen = "0.53.1"
11+
12+
[lib]
13+
bench = false
14+
doctest = false
15+
crate-type = ["lib", "dylib"]
16+
17+
[profile.release]
18+
opt-level = "z"
19+
lto = true
20+
codegen-units = 1
21+
incremental = false
22+
# See: https://github.com/johnthagen/min-sized-rust

‎LICENSE

Lines changed: 191 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction, and
10+
distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by the copyright
13+
owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all other entities
16+
that control, are controlled by, or are under common control with that entity.
17+
For the purposes of this definition, "control" means (i) the power, direct or
18+
indirect, to cause the direction or management of such entity, whether by
19+
contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
20+
outstanding shares, or (iii) beneficial ownership of such entity.
21+
22+
"You" (or "Your") shall mean an individual or Legal Entity exercising
23+
permissions granted by this License.
24+
25+
"Source" form shall mean the preferred form for making modifications, including
26+
but not limited to software source code, documentation source, and configuration
27+
files.
28+
29+
"Object" form shall mean any form resulting from mechanical transformation or
30+
translation of a Source form, including but not limited to compiled object code,
31+
generated documentation, and conversions to other media types.
32+
33+
"Work" shall mean the work of authorship, whether in Source or Object form, made
34+
available under the License, as indicated by a copyright notice that is included
35+
in or attached to the work (an example is provided in the Appendix below).
36+
37+
"Derivative Works" shall mean any work, whether in Source or Object form, that
38+
is based on (or derived from) the Work and for which the editorial revisions,
39+
annotations, elaborations, or other modifications represent, as a whole, an
40+
original work of authorship. For the purposes of this License, Derivative Works
41+
shall not include works that remain separable from, or merely link (or bind by
42+
name) to the interfaces of, the Work and Derivative Works thereof.
43+
44+
"Contribution" shall mean any work of authorship, including the original version
45+
of the Work and any modifications or additions to that Work or Derivative Works
46+
thereof, that is intentionally submitted to Licensor for inclusion in the Work
47+
by the copyright owner or by an individual or Legal Entity authorized to submit
48+
on behalf of the copyright owner. For the purposes of this definition,
49+
"submitted" means any form of electronic, verbal, or written communication sent
50+
to the Licensor or its representatives, including but not limited to
51+
communication on electronic mailing lists, source code control systems, and
52+
issue tracking systems that are managed by, or on behalf of, the Licensor for
53+
the purpose of discussing and improving the Work, but excluding communication
54+
that is conspicuously marked or otherwise designated in writing by the copyright
55+
owner as "Not a Contribution."
56+
57+
"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
58+
of whom a Contribution has been received by Licensor and subsequently
59+
incorporated within the Work.
60+
61+
2. Grant of Copyright License.
62+
63+
Subject to the terms and conditions of this License, each Contributor hereby
64+
grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
65+
irrevocable copyright license to reproduce, prepare Derivative Works of,
66+
publicly display, publicly perform, sublicense, and distribute the Work and such
67+
Derivative Works in Source or Object form.
68+
69+
3. Grant of Patent License.
70+
71+
Subject to the terms and conditions of this License, each Contributor hereby
72+
grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
73+
irrevocable (except as stated in this section) patent license to make, have
74+
made, use, offer to sell, sell, import, and otherwise transfer the Work, where
75+
such license applies only to those patent claims licensable by such Contributor
76+
that are necessarily infringed by their Contribution(s) alone or by combination
77+
of their Contribution(s) with the Work to which such Contribution(s) was
78+
submitted. If You institute patent litigation against any entity (including a
79+
cross-claim or counterclaim in a lawsuit) alleging that the Work or a
80+
Contribution incorporated within the Work constitutes direct or contributory
81+
patent infringement, then any patent licenses granted to You under this License
82+
for that Work shall terminate as of the date such litigation is filed.
83+
84+
4. Redistribution.
85+
86+
You may reproduce and distribute copies of the Work or Derivative Works thereof
87+
in any medium, with or without modifications, and in Source or Object form,
88+
provided that You meet the following conditions:
89+
90+
You must give any other recipients of the Work or Derivative Works a copy of
91+
this License; and
92+
You must cause any modified files to carry prominent notices stating that You
93+
changed the files; and
94+
You must retain, in the Source form of any Derivative Works that You distribute,
95+
all copyright, patent, trademark, and attribution notices from the Source form
96+
of the Work, excluding those notices that do not pertain to any part of the
97+
Derivative Works; and
98+
If the Work includes a "NOTICE" text file as part of its distribution, then any
99+
Derivative Works that You distribute must include a readable copy of the
100+
attribution notices contained within such NOTICE file, excluding those notices
101+
that do not pertain to any part of the Derivative Works, in at least one of the
102+
following places: within a NOTICE text file distributed as part of the
103+
Derivative Works; within the Source form or documentation, if provided along
104+
with the Derivative Works; or, within a display generated by the Derivative
105+
Works, if and wherever such third-party notices normally appear. The contents of
106+
the NOTICE file are for informational purposes only and do not modify the
107+
License. You may add Your own attribution notices within Derivative Works that
108+
You distribute, alongside or as an addendum to the NOTICE text from the Work,
109+
provided that such additional attribution notices cannot be construed as
110+
modifying the License.
111+
You may add Your own copyright statement to Your modifications and may provide
112+
additional or different license terms and conditions for use, reproduction, or
113+
distribution of Your modifications, or for any such Derivative Works as a whole,
114+
provided Your use, reproduction, and distribution of the Work otherwise complies
115+
with the conditions stated in this License.
116+
117+
5. Submission of Contributions.
118+
119+
Unless You explicitly state otherwise, any Contribution intentionally submitted
120+
for inclusion in the Work by You to the Licensor shall be under the terms and
121+
conditions of this License, without any additional terms or conditions.
122+
Notwithstanding the above, nothing herein shall supersede or modify the terms of
123+
any separate license agreement you may have executed with Licensor regarding
124+
such Contributions.
125+
126+
6. Trademarks.
127+
128+
This License does not grant permission to use the trade names, trademarks,
129+
service marks, or product names of the Licensor, except as required for
130+
reasonable and customary use in describing the origin of the Work and
131+
reproducing the content of the NOTICE file.
132+
133+
7. Disclaimer of Warranty.
134+
135+
Unless required by applicable law or agreed to in writing, Licensor provides the
136+
Work (and each Contributor provides its Contributions) on an "AS IS" BASIS,
137+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
138+
including, without limitation, any warranties or conditions of TITLE,
139+
NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
140+
solely responsible for determining the appropriateness of using or
141+
redistributing the Work and assume any risks associated with Your exercise of
142+
permissions under this License.
143+
144+
8. Limitation of Liability.
145+
146+
In no event and under no legal theory, whether in tort (including negligence),
147+
contract, or otherwise, unless required by applicable law (such as deliberate
148+
and grossly negligent acts) or agreed to in writing, shall any Contributor be
149+
liable to You for damages, including any direct, indirect, special, incidental,
150+
or consequential damages of any character arising as a result of this License or
151+
out of the use or inability to use the Work (including but not limited to
152+
damages for loss of goodwill, work stoppage, computer failure or malfunction, or
153+
any and all other commercial damages or losses), even if such Contributor has
154+
been advised of the possibility of such damages.
155+
156+
9. Accepting Warranty or Additional Liability.
157+
158+
While redistributing the Work or Derivative Works thereof, You may choose to
159+
offer, and charge a fee for, acceptance of support, warranty, indemnity, or
160+
other liability obligations and/or rights consistent with this License. However,
161+
in accepting such obligations, You may act only on Your own behalf and on Your
162+
sole responsibility, not on behalf of any other Contributor, and only if You
163+
agree to indemnify, defend, and hold each Contributor harmless for any liability
164+
incurred by, or claims asserted against, such Contributor by reason of your
165+
accepting any such warranty or additional liability.
166+
167+
END OF TERMS AND CONDITIONS
168+
169+
APPENDIX: How to apply the Apache License to your work
170+
171+
To apply the Apache License to your work, attach the following boilerplate
172+
notice, with the fields enclosed by brackets "[]" replaced with your own
173+
identifying information. (Don't include the brackets!) The text should be
174+
enclosed in the appropriate comment syntax for the file format. We also
175+
recommend that a file or class name and description of purpose be included on
176+
the same "printed page" as the copyright notice for easier identification within
177+
third-party archives.
178+
179+
Copyright [yyyy] [name of copyright owner]
180+
181+
Licensed under the Apache License, Version 2.0 (the "License");
182+
you may not use this file except in compliance with the License.
183+
You may obtain a copy of the License at
184+
185+
http://www.apache.org/licenses/LICENSE-2.0
186+
187+
Unless required by applicable law or agreed to in writing, software
188+
distributed under the License is distributed on an "AS IS" BASIS,
189+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
190+
See the License for the specific language governing permissions and
191+
limitations under the License.

‎README.md

Lines changed: 66 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,66 @@
1-
# couchbase-lite-rust
2-
EXPERIMENTAL Rust Bindings For Couchbase Lite
1+
# EXPERIMENTAL Rust Bindings For Couchbase Lite
2+
3+
This is a Rust API binding of [Couchbase Lite][CBL], an embedded NoSQL document database engine with sync.
4+
5+
## Disclaimer
6+
7+
> This library is **NOT SUPPORTED BY COUCHBASE**. Even if you are a Couchbase customer, our otherwise awesome support team cannot help you with using this library.
8+
9+
As of September 2021, this library is still incomplete and has been tested only partially and informally, mostly on one platform (macOS). Also the author is a novice Rustacean and may not be doing things the Rust Way.
10+
11+
That said, we would like to maintain and improve this library as time permits. We welcome bug reports, fixes and improvements!
12+
13+
## Building
14+
15+
**_"Some assembly required..."_**
16+
17+
### 1. Install LLVM/Clang
18+
19+
In addition to [Rust][RUST], you'll need to install LLVM and Clang, which are required by the
20+
[bindgen][BINDGEN] tool that generates Rust FFI APIs from C headers.
21+
Installation instructions are [here][BINDGEN_INSTALL].
22+
23+
### 2. Get Couchbase Lite For C
24+
25+
Next you need the Couchbase Lite For C shared library and headers. You can download them from Couchbase, or build them yourself from the [Git repo][CBL_C].
26+
27+
### 3. Fix The Skanky Hardcoded Paths
28+
29+
Now edit the file `CouchbaseLite/build.rs` and edit the hardcoded paths on lines 32-37.
30+
This tells the crate where to find Couchbase Lite's headers and library, and the Clang libraries.
31+
32+
### 4. Build!
33+
34+
$ cargo build
35+
36+
### 5. Test
37+
38+
**The unit tests must be run single-threaded.** This is because each test case checks for leaks by
39+
counting the number of extant Couchbase Lite objects before and after it runs, and failing if the
40+
number increases. That works only if a single test runs at a time.
41+
42+
$ cargo test -- --test-threads 1
43+
44+
The library itself has no thread-safety problems; if you want to run the tests multi-threaded, just
45+
edit `tests/simple_tests.rs` and change the value of `LEAK_CHECKS` to `false`.
46+
47+
## Learning
48+
49+
I've copied the doc-comments from the C API into the Rust files. But Couchbase Lite is fairly
50+
complex, so if you're not already familiar with it, you'll want to start by reading through
51+
the [official documentation][CBLDOCS].
52+
53+
The Rust API is mostly method-for-method compatible with the languages documented there, except
54+
down at the document property level (dictionaries, arrays, etc.) where I haven't yet written
55+
compatible bindings. For those APIs you can check out the document "[Using Fleece][FLEECE]".
56+
57+
(FYI, if you want to see what bindgen's Rust translation of the C API looks like, it's in the file `bindings.rs` in `build/couchbase-lite-*/out`, where "`*`" will be some hex string. This is super unlikely to be useful unless you want to work on improving the high-level bindings themselves.)
58+
59+
60+
[RUST]: https://www.rust-lang.org
61+
[CBL]: https://www.couchbase.com/products/lite
62+
[CBL_C]: https://github.com/couchbase/couchbase-lite-C
63+
[CBLDOCS]: https://docs.couchbase.com/couchbase-lite/current/introduction.html
64+
[FLEECE]: https://github.com/couchbaselabs/fleece/wiki/Using-Fleece
65+
[BINDGEN]: https://rust-lang.github.io/rust-bindgen/
66+
[BINDGEN_INSTALL]: https://rust-lang.github.io/rust-bindgen/requirements.html

0 commit comments

Comments
 (0)