fix(ffi): fixed create simple logger implementation, removed duplicated word in comment#95
Merged
Merged
Conversation
…ed word in comment
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR resolves an initialization failure in the FFI tutorial example where
create_simple_loggerfails to create a logger if the target log file does not already exist.Currently, the
create_simple_loggerfunction hardcodes theoverwriteparameter tofalsewhen callingSimpleLogger::new. Under the hood, thecreate_or_open_log_filehelper routesfalsetoOpenOptions::new().write(true).append(true).open(log_file). Because it lacks the.create(true)flag, this call returns an error on a fresh run when the file is absent. As a result, the FFI wrapper catches the error, returns1, and leaves the C-caller without a valid logger instance. From my perspective, current behavior is somewhat counterintuitive for an educational example, as it forces the reader to manually create the file before running the code or figure out why it silently fails.Proposed Changes
To ensure the example works out-of-the-box:
overwriteargument fromfalsetotrueinsidecreate_simple_logger. This ensuresFile::createis called, guaranteeing the file is generated if it doesn't exist.in in real life->in real life) in the adjacent comment block.Types of changes
Checklist: