dreae / base32768-rs Goto Github PK

encode returns Result<String, errors::Base32768Error>, but it does not document how or why an error would be returned.

Are there some byte sequences base32768 cannot represent? Is there anything I can do to detect these beforehand, or anything I can do to remedy an error if it occurs?

In short, I'd really like to have some documentation for why this function can fail, and what I can do about it. It returning a Result rather than panicking implies that failure has something to do with the input conditions, but I can't find any documentation on this.

Hi,

base32768 returns a result with an error type, but the error type is in a private module. Could it be re-exported in lib.rs so that it's actually usable?

I'd suggest pub use errors::Base32768Error as Error in lib.rs.