Skip to content

Commit 18e605e

Browse files
committed
fixup! Add empty postgres KvStore implementation.
1 parent cbe624b commit 18e605e

File tree

2 files changed

+16
-0
lines changed

2 files changed

+16
-0
lines changed

rust/impls/src/lib.rs

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,15 @@
1+
//! Hosts VSS protocol compliant [`KvStore`] implementations for various backends.
2+
//!
3+
//! VSS is an open-source project designed to offer a server-side cloud storage solution specifically
4+
//! tailored for noncustodial Lightning supporting mobile wallets. Its primary objective is to
5+
//! simplify the development process for Lightning wallets by providing a secure means to store
6+
//! and manage the essential state required for Lightning Network (LN) operations.
7+
//!
8+
//! [`KvStore`]: api::kv_store::KvStore
9+
10+
#![deny(rustdoc::broken_intra_doc_links)]
11+
#![deny(rustdoc::private_intra_doc_links)]
12+
#![deny(missing_docs)]
13+
14+
/// Contains [PostgreSQL](https://www.postgresql.org/) based backend implementation for VSS.
115
pub mod postgres_store;

rust/impls/src/postgres_store.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,11 @@ use api::types::{
77
use async_trait::async_trait;
88
use std::io::Error;
99

10+
/// A [PostgreSQL](https://www.postgresql.org/) based backend implementation for VSS.
1011
pub struct PostgresBackendImpl {}
1112

1213
impl PostgresBackendImpl {
14+
/// Constructs a [`PostgresBackendImpl`] using `dsn` for PostgreSQL connection information.
1315
pub async fn new(dsn: &str) -> Result<Self, Error> {
1416
todo!("pending implementation.");
1517
}

0 commit comments

Comments
 (0)