-
Notifications
You must be signed in to change notification settings - Fork 1.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix docs.rs #3580
Fix docs.rs #3580
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -28,12 +28,11 @@ fn main() -> Result<(), String> { | |
Ok(()) | ||
} | ||
|
||
#[cfg(feature = "json")] | ||
fn build() -> Result<(), String> { | ||
use std::io::Write; | ||
|
||
let out = std::path::PathBuf::from( | ||
std::env::var("OUT_DIR").expect("Cannot find OUT_DIR environment vairable"), | ||
std::env::var("OUT_DIR").expect("Cannot find OUT_DIR environment variable"), | ||
); | ||
let descriptor_path = out.join("proto_descriptor.bin"); | ||
|
||
|
@@ -44,9 +43,11 @@ fn build() -> Result<(), String> { | |
.compile_protos(&["proto/datafusion.proto"], &["proto"]) | ||
.map_err(|e| format!("protobuf compilation failed: {}", e))?; | ||
|
||
#[cfg(feature = "json")] | ||
let descriptor_set = std::fs::read(&descriptor_path) | ||
.expect(&*format!("Cannot read {:?}", &descriptor_path)); | ||
|
||
#[cfg(feature = "json")] | ||
pbjson_build::Builder::new() | ||
.register_descriptors(&descriptor_set) | ||
.expect(&*format!( | ||
|
@@ -58,22 +59,25 @@ fn build() -> Result<(), String> { | |
|
||
// .serde.rs is not a valid package name, so append to datafusion.rs so we can treat it normally | ||
let proto = std::fs::read_to_string(out.join("datafusion.rs")).unwrap(); | ||
|
||
#[cfg(feature = "json")] | ||
let json = std::fs::read_to_string(out.join("datafusion.serde.rs")).unwrap(); | ||
|
||
#[cfg(feature = "docsrs")] | ||
let path = out.join("datafusion.rs"); | ||
#[cfg(not(feature = "docsrs"))] | ||
let path = "src/generated/datafusion.rs"; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Change generated path to src or out_dir as appropriate. |
||
|
||
let mut file = std::fs::OpenOptions::new() | ||
.write(true) | ||
.truncate(true) | ||
.create(true) | ||
.open("src/generated/datafusion_json.rs") | ||
.open(path) | ||
.unwrap(); | ||
file.write(proto.as_str().as_ref()).unwrap(); | ||
file.write(json.as_str().as_ref()).unwrap(); | ||
file.write_all(proto.as_str().as_ref()).unwrap(); | ||
|
||
Ok(()) | ||
} | ||
#[cfg(feature = "json")] | ||
file.write_all(json.as_str().as_ref()).unwrap(); | ||
|
||
#[cfg(not(feature = "json"))] | ||
fn build() -> Result<(), String> { | ||
prost_build::Config::new() | ||
.out_dir("src/generated") | ||
.compile_protos(&["proto/datafusion.proto"], &["proto"]) | ||
.map_err(|e| format!("protobuf compilation failed: {}", e)) | ||
Ok(()) | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -15,13 +15,16 @@ | |
// specific language governing permissions and limitations | ||
// under the License. | ||
|
||
// include the generated protobuf source as a submodule | ||
#[allow(clippy::all)] | ||
#[rustfmt::skip] | ||
#[cfg(not(feature = "json"))] | ||
#[cfg(not(docsrs))] | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. When we have a writable source folder, generate into that. |
||
pub mod datafusion; | ||
|
||
#[cfg(docsrs)] | ||
#[allow(clippy::all)] | ||
#[rustfmt::skip] | ||
#[cfg(feature = "json")] | ||
pub mod datafusion_json; | ||
pub mod datafusion { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. When not writable, pull from OUT_DIR. |
||
include!(concat!(env!("OUT_DIR"), "/datafusion.rs")); | ||
|
||
#[cfg(feature = "json")] | ||
include!(concat!(env!("OUT_DIR"), "/datafusion.serde.rs")); | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -25,10 +25,7 @@ pub mod generated; | |
pub mod logical_plan; | ||
pub mod to_proto; | ||
|
||
#[cfg(not(feature = "json"))] | ||
pub use generated::datafusion as protobuf; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Now the module name is always the same! :D |
||
#[cfg(feature = "json")] | ||
pub use generated::datafusion_json as protobuf; | ||
|
||
#[cfg(doctest)] | ||
doc_comment::doctest!("../README.md", readme_example_test); | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
docs.rs will set this, according to their docs.