From 8e56f10e2c841cec8b90b87559feeb8333a3a653 Mon Sep 17 00:00:00 2001 From: sergeych Date: Tue, 10 Oct 2023 07:02:36 +0100 Subject: [PATCH] getting ready for publication: license, removind debug cideF --- LICENSE | 17 ----------------- README.md | 11 ++++++++++- src/bipack_sink.rs | 14 ++++++++++++++ src/bipack_source.rs | 14 ++++++++++++++ src/lib.rs | 15 ++++++++++++++- src/tools.rs | 14 +++++++++++++- 6 files changed, 65 insertions(+), 20 deletions(-) diff --git a/LICENSE b/LICENSE index 3058c8d..1292dbb 100644 --- a/LICENSE +++ b/LICENSE @@ -54,20 +54,3 @@ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION END OF TERMS AND CONDITIONS -APPENDIX: How to apply the Apache License to your work. - -To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. - -Copyright 2023 Divan - -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - -http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. diff --git a/README.md b/README.md index b886fec..0fa4f57 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,12 @@ # bipack_ru -Bipack format implementation, minimalistic by purpose. \ No newline at end of file +Bipack format implementation, minimalistic by purpose. + +At the moment it does not include `serde` module as it is yet unclear how much +it will increase .wasm size. Could be added later. + +The autodoc documentation is good enough already, so we do not repeat it here now. + +# License + +For compyance with other modules this work is provided under APACHE 2.0 license a copy of which is included in the file `LICENSE`. \ No newline at end of file diff --git a/src/bipack_sink.rs b/src/bipack_sink.rs index d968356..5978a82 100644 --- a/src/bipack_sink.rs +++ b/src/bipack_sink.rs @@ -1,3 +1,17 @@ +// Copyright 2023 by Sergey S. Chernov. +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + use std::iter::Iterator; use std::usize; diff --git a/src/bipack_source.rs b/src/bipack_source.rs index 6bfc981..1001bf5 100644 --- a/src/bipack_source.rs +++ b/src/bipack_source.rs @@ -1,3 +1,17 @@ +// Copyright 2023 by Sergey S. Chernov. +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + use std::error::Error; use std::fmt::{Display, Formatter}; use std::string::FromUtf8Error; diff --git a/src/lib.rs b/src/lib.rs index 1c8a8d1..308917b 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,3 +1,17 @@ +// Copyright 2023 by Sergey S. Chernov. +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + //! # Bipack codec //! //! The set of tools to effectively encode and decode bipack values. It is internationally @@ -117,7 +131,6 @@ mod tests { .expect("decoded vector"); println!(": {}", hex::encode(&src)); let mut ss = SliceSource::from(&src); - let d7 = ss.get_u8()?; assert_eq!(7, ss.get_u8()?); assert_eq!(64000, ss.get_u16()?); assert_eq!(66000, ss.get_u32()?); diff --git a/src/tools.rs b/src/tools.rs index d5d9f93..661728e 100644 --- a/src/tools.rs +++ b/src/tools.rs @@ -1,4 +1,16 @@ -// use string_builder::Builder; +// Copyright 2023 by Sergey S. Chernov. +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. use string_builder::Builder;